set-policies - Unkey Docs

Replace an environment's complete ordered policy list. An empty list removes every policy. The operation is atomic and accepts at most 50 policies.

Usage#

unkey api gateway set-policies [flags]

Flags#

--projectstringrequired#

Project ID or slug.

--appstringrequired#

Application ID or slug.

--environmentstringrequired#

Environment ID or slug.

--policiesJSON stringrequired#

The complete policy list in evaluation order. Each policy requires name and enabled, and exactly one of keyauth, ratelimit, firewall, openapi, or logging.

Show JSON schema

namestringrequired#

Dashboard name.

enabledbooleanrequired#

Whether evaluation is enabled.

matcharray#

Optional path, method, header, or query parameter match expressions.

keyauthobject#

Keyspaces, locations, permission query, and rate limits.

ratelimitobject#

Limit, windowMs, and identifiers.

firewallobject#

Firewall action.

openapiobject#

OpenAPI validation configuration.

loggingobject#

Logging configuration.

Global Flags#

Flag	Type	Description
`--root-key`	string	Override root key (`$UNKEY_ROOT_KEY`)
`--api-url`	string	Override API base URL (default: `https://api.unkey.com`)
`--config`	string	Path to config file (default: `~/.unkey/config.toml`)
`--output`	string	Output format, use `json` for raw JSON
`--body`	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples#

unkey api gateway set-policies --project=payments --app=payments-api --environment=production --policies='[{"name":"Block internal","enabled":true,"firewall":{"action":"ACTION_DENY"}}]'

See the API reference.