Deployments.ai Docs
Command reference

deployments credential

Static provider credentials

CommandSummary
deployments credential createRegister a static provider credential
deployments credential listList provider credentials
deployments credential rotateRotate a provider credential
deployments credential revokeRevoke a provider credential

deployments credential create

Register a static provider credential.

deployments credential create --name <name> --provider <provider>
  • Calls POST /v1/credentials (SDK createProviderCredential).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--providerstringyesProvider key
--credentialstringCredential bundle (prefer env or file source)
--credential-envstringEnvironment variable containing the credential
--credential-filestringFile containing the credential
--metadatastring (json)Non-secret provider metadata
--resourcestringVendor MCP tenant endpoint for a templated server URL

Also accepts the global flags.

deployments credential list

List provider credentials.

deployments credential list
  • Calls GET /v1/credentials (SDK listProviderCredentials).
  • 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 credential rotate

Rotate a provider credential.

deployments credential rotate <id> --expected-version <number>
  • Calls POST /v1/credentials/{id}/rotate (SDK rotateProviderCredential).
  • 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.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected resource version
--credentialstringReplacement credential (prefer env or file source)
--credential-envstringEnvironment variable containing the replacement credential
--credential-filestringFile containing the replacement credential

Also accepts the global flags.

deployments credential revoke

Revoke a provider credential.

deployments credential revoke <id>
  • Calls DELETE /v1/credentials/{id} (SDK revokeProviderCredential).
  • 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