Deployments.ai Docs
Command reference

deployments connection

Provider connections and verification

CommandSummary
deployments connection authorizeStart provider authorization
deployments connection listList provider connections
deployments connection showShow a provider connection
deployments connection verifyVerify a provider connection
deployments connection revokeRevoke a provider connection
deployments connection tools-syncSync vendor MCP tools for a provider connection

deployments connection authorize

Start provider authorization.

deployments connection authorize --provider <provider>
  • Calls POST /v1/connections (SDK beginProviderAuthorization).
  • 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
--providerstringyesProvider key
--oauth-appstringOAuth application registration ID
--resourcestringProvider account or external resource to authorize
--return-urlstringhttps URL on an allowlisted return origin (PLATFORM_OAUTH_RETURN_ORIGINS); the callback redirects there with connection_id and provider, or error

Also accepts the global flags.

deployments connection list

List provider connections.

deployments connection list
  • Calls GET /v1/connections (SDK listProviderConnections).
  • 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 connection show

Show a provider connection.

deployments connection show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments connection verify

Verify a provider connection.

deployments connection verify <id>
  • Calls POST /v1/connections/{id}/verify (SDK requestConnectionVerification).
  • 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
<id>positionalyesResource ID

Also accepts the global flags.

deployments connection revoke

Revoke a provider connection.

deployments connection revoke <id>
  • Calls DELETE /v1/connections/{id} (SDK revokeProviderConnection).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

deployments connection tools-sync

Sync vendor MCP tools for a provider connection.

deployments connection tools-sync <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page