Deployments.ai Docs
Command reference

deployments tool-policy

Tool permissions and approval policy

CommandSummary
deployments tool-policy createCreate a tool policy
deployments tool-policy listList tool policies
deployments tool-policy showShow a tool policy
deployments tool-policy updateUpdate a tool policy
deployments tool-policy archiveArchive a tool policy
deployments tool-policy evaluateShow what a tool policy or an agent deployment's pinned policies decide for tools (no side effects)

deployments tool-policy create

Create a tool policy.

deployments tool-policy create --name <name> --policy <json>
  • Calls POST /v1/tool-policies (SDK createToolPolicy).
  • 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
--namestringyesResource name
--descriptionstringResource description
--policystring (json)yesTool policy document

Also accepts the global flags.

deployments tool-policy list

List tool policies.

deployments tool-policy list
  • Calls GET /v1/tool-policies (SDK listToolPolicies).
  • 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 tool-policy show

Show a tool policy.

deployments tool-policy show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments tool-policy update

Update a tool policy.

deployments tool-policy update <id> --expected-version <number>
  • Calls PATCH /v1/tool-policies/{id} (SDK updateToolPolicy).
  • 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
--policystring (json)Tool policy document
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments tool-policy archive

Archive a tool policy.

deployments tool-policy archive <id>
  • Calls DELETE /v1/tool-policies/{id} (SDK archiveToolPolicy).
  • 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 tool-policy evaluate

Show what a tool policy or an agent deployment's pinned policies decide for tools (no side effects).

deployments tool-policy evaluate
FlagTypeRequiredDefaultDescription
--tool-policy-idstringTool policy to evaluate (requires --tool)
--agent-deployment-idstringAgent deployment whose pinned tool policies to evaluate
--toolstringTool name to evaluate (repeatable)

Also accepts the global flags.

On this page