Deployments.ai Docs
Command reference

deployments model-policy

Environment model admission policy

CommandSummary
deployments model-policy createCreate the environment model policy
deployments model-policy listList model policies
deployments model-policy showShow a model policy
deployments model-policy updateUpdate a model policy
deployments model-policy archiveArchive a model policy

deployments model-policy create

Create the environment model policy.

deployments model-policy create --name <name> --include-curated-models
  • Calls POST /v1/model-policies (SDK createModelPolicy).
  • 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
--include-curated-modelsbooleanyesKeep the platform's curated models allowed; pass --no-include-curated-models to allow only the listed models
--modelstringAllowed canonical model id or provider-wide entry such as openrouter/* (repeatable)
--modelsstring (json)Allowed model entries as a JSON array

Also accepts the global flags.

deployments model-policy list

List model policies.

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

Show a model policy.

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

Also accepts the global flags.

deployments model-policy update

Update a model policy.

deployments model-policy update <id> --expected-version <number>
  • Calls PATCH /v1/model-policies/{id} (SDK updateModelPolicy).
  • 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
--namestringResource name
--descriptionstringResource description
--include-curated-modelsbooleanKeep the platform's curated models allowed; pass --no-include-curated-models to allow only the listed models
--modelstringAllowed canonical model id or provider-wide entry such as openrouter/* (repeatable)
--modelsstring (json)Allowed model entries as a JSON array
--expected-versionstring (number)yesExpected model policy version

Also accepts the global flags.

deployments model-policy archive

Archive a model policy.

deployments model-policy archive <id> --expected-version <number>
  • Calls DELETE /v1/model-policies/{id} (SDK archiveModelPolicy).
  • 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
--expected-versionstring (number)yesExpected model policy version

Also accepts the global flags.

On this page