Deployments.ai Docs
Command reference

deployments grant

Agent connection grants

CommandSummary
deployments grant createGrant a connection to an agent
deployments grant listList connection grants
deployments grant showShow a connection grant
deployments grant revokeRevoke a connection grant

deployments grant create

Grant a connection to an agent.

deployments grant create --connection <connection> --purpose <purpose> --scopes <a-b-c>
  • Calls POST /v1/connection-grants (SDK createConnectionGrant).
  • 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
--workspacestringWorkspace ID
--all-workspacesbooleanGrant the connection to every workspace in the environment
--connectionstringyesProvider connection ID
--constraintsstring (json)External resource constraints
--purposestringyesAuthorization purpose
--scopesstring (a,b,c)yesGranted connection scopes

Also accepts the global flags.

deployments grant list

List connection grants.

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

Show a connection grant.

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

Also accepts the global flags.

deployments grant revoke

Revoke a connection grant.

deployments grant revoke <id>
  • Calls DELETE /v1/connection-grants/{id} (SDK revokeConnectionGrant).
  • 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.

On this page