Skip to main content

Update Integration

Use the tcb integration update command to update an existing integration configuration.

tcb integration update [options]

Command Parameters​

ParameterDescriptionRequired
--key-id <keyId>Integration Key IDNo (either this or --name)
--name <name>Integration name (used to query the integration to update)No (either this or --key-id)
--new-name <newName>New integration nameNo
--description <description>New integration descriptionNo
--jsonOutput results in JSON formatNo
--yesSkip interactive confirmationNo

Usage Examples​

Update Integration Name​

# Update by Key ID
tcb integration update --key-id key-xxx --new-name new-integration-name

# Query by name and update
tcb integration update --name old-name --new-name new-name

Update Integration Description​

tcb integration update --key-id key-xxx --description "Updated description"

Update Name and Description Together​

tcb integration update --key-id key-xxx --new-name new-name --description "New description"

JSON Format Output​

tcb integration update --key-id key-xxx --new-name new-name --json

Automation Script​

In CI/CD pipelines, it is recommended to use the --yes parameter to skip interactive confirmation:

tcb integration update --key-id key-xxx --new-name new-name --yes

Output Examples​

Standard Output​

✓ Integration updated successfully

Integration info:
  Key ID: key-721a6e232e169382d3cbc5faa3dc2cd6
  Name: new-integration-name
  Auth type: custom
  Description: Updated description

Next steps:
  Use 'tcb integration get --key-id key-721a6e232e169382d3cbc5faa3dc2cd6' to view details
  Use 'tcb integration bind-resource --key-id key-721a6e232e169382d3cbc5faa3dc2cd6 --function <function-name>' to bind to a cloud function

JSON Output​

{
  "RequestId": "abc-123-def-456"
}

Notes​

  • Authentication type (AuthTypeCode) cannot be modified after creation
  • When updating the name, the new name cannot duplicate existing integrations
  • If no update content is specified (--new-name or --description), the command will prompt an error