Deployments.ai Docs
Command reference

deployments channel-binding

Inbound and outbound channel bindings

CommandSummary
deployments channel-binding listList channel bindings
deployments channel-binding createCreate a channel binding
deployments channel-binding showShow a channel binding
deployments channel-binding updateUpdate a channel binding
deployments channel-binding set-credentialAttach or rotate a channel runtime credential and disable the binding until verification
deployments channel-binding revoke-credentialRevoke a channel runtime credential and disable its binding
deployments channel-binding archiveArchive a channel binding
deployments channel-binding verifyVerify a channel binding
deployments channel-binding deliverCompose an outbound channel delivery

deployments channel-binding list

List channel bindings.

deployments channel-binding list
  • Calls GET /v1/channel-bindings (SDK listChannelBindings).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments channel-binding create

Create a channel binding.

deployments channel-binding create --agent-definition-id <agent-definition-id> --agent-deployment-id <agent-deployment-id> --channel <channel> --provider <provider>
  • Calls POST /v1/channel-bindings (SDK createChannelBinding).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--agent-definition-idstringyesAgent definition ID
--agent-deployment-idstringyesAgent deployment ID
--channelstringyesimessage, rcs, slack, sms, teams, or telegram
--connection-idstringConnection ID
--external-account-idstringExternal account ID
--external-channel-idstringExternal channel ID
--external-thread-keystringExternal thread key
--external-workspace-idstringExternal workspace ID
--metadatastring (json)Channel binding metadata
--providerstringyesaws_end_user_messaging_rcs, slack_cloudflare_edge, slack_edge, teams_bot_framework, or telegram
--workspace-idstringWorkspace ID

Also accepts the global flags.

deployments channel-binding show

Show a channel binding.

deployments channel-binding show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments channel-binding update

Update a channel binding.

deployments channel-binding update <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--agent-deployment-idstringAgent deployment ID
--clear-agent-deployment-idbooleanClear the agent deployment ID
--clear-connection-idbooleanClear the connection ID
--clear-external-account-idbooleanClear the external account ID
--clear-external-channel-idbooleanClear the external channel ID
--clear-external-thread-keybooleanClear the external thread key
--clear-external-workspace-idbooleanClear the external workspace ID
--clear-metadatabooleanClear channel binding metadata
--connection-idstringConnection ID
--external-account-idstringExternal account ID
--external-channel-idstringExternal channel ID
--external-thread-keystringExternal thread key
--external-workspace-idstringExternal workspace ID
--metadatastring (json)Channel binding metadata

Also accepts the global flags.

deployments channel-binding set-credential

Attach or rotate a channel runtime credential and disable the binding until verification.

deployments channel-binding set-credential <id> --expected-version <number>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesCurrent binding version
--valuesstringCredential values as a JSON object (prefer env or file source)
--values-envstringEnvironment variable containing credential JSON
--values-filestringFile containing credential JSON
--scopesstring (a,b,c)Granted credential scopes
--expires-atstringCredential expiration timestamp

Also accepts the global flags.

deployments channel-binding revoke-credential

Revoke a channel runtime credential and disable its binding.

deployments channel-binding revoke-credential <id> --expected-version <number>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesCurrent binding version

Also accepts the global flags.

deployments channel-binding archive

Archive a channel binding.

deployments channel-binding archive <id>
  • Calls DELETE /v1/channel-bindings/{bindingId} (SDK deleteChannelBinding).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments channel-binding verify

Verify a channel binding.

deployments channel-binding verify <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments channel-binding deliver

Compose an outbound channel delivery.

deployments channel-binding deliver <id> --content <content> --external-thread-key <external-thread-key> --run-id <run-id> --thread-id <thread-id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--contentstringyesOutbound delivery content
--external-channel-idstringExternal channel ID
--external-thread-keystringyesExternal thread key
--run-idstringyesRun ID
--thread-idstringyesThread ID

Also accepts the global flags.

On this page