Skip to main content
Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
Replace the gateway policies of an in one atomic request. Policies run at the edge before a request reaches your : they API keys, , block requests outright, or validate them against your OpenAPI spec. Each policy sets exactly one of keyauth, ratelimit, firewall, openapi, or logging, plus up to ten optional match expressions that restrict which requests it applies to. Every call replaces the whole list. The environment’s policies become exactly the array you send, in that order, and each one gets a new ID. An empty array removes all policies. An environment can have up to 50 policies. If any policy is invalid, nothing is saved.

Usage

Flags

string
required
App ID or slug.
string
required
Environment ID or slug.
string
required
JSON array containing the complete ordered policy list.
string
required
ID or slug. Both forms resolve to the same project.

Shared flags

Every resource command accepts these; CLI output and shared flags describes them in full.
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.
enum
default:"human"
Use human (default) for name-first summary tables and single-response trees, or json for the unchanged full response envelope, including all fields and pagination. Trees wrap long values without truncation. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.
boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid --output or UNKEY_OUTPUT value.

Required permissions

Your root key needs both permissions on the target environment’s gateway policies:
  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/gateway/policies/*#write
  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/gateway/policies/*#delete
Replace the placeholders with resource IDs. Wildcard grants can cover multiple resources, but access remains limited to the root key’s workspace. See Root key permissions for the full catalog.

Examples

Require an API key from one keyspace. A keyauth rule names one to five keyspaces, and each one must exist in your workspace. Otherwise the call fails with Keyspace "<id>" does not exist. and nothing is saved.
Remove every policy:
Send the request body as JSON:

API endpoint

The command calls POST /v2/gateway.setPolicies and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.

Gateway policies

How policies are ordered, matched, and evaluated at the edge.
Last modified on November 11, 2026