Set API key stack permissions

Creates or replaces all nine public levels of the key on one stack. They replace the key's defaults on that stack only, not as an allowlist; defaults and other stacks remain unchanged. Creating requires an active workspace-managed WORKSPACE key (403 otherwise); existing entries of retained deactivated keys can be replaced without reactivation. Equal levels write nothing. Optional If-Match checks the current GET representation under the key and entry locks, with management permission rechecked after waits; * on a missing entry returns 412. PUT omits ETag: GET the stack permissions for a current validator. Credentials, scope, ownership and permanent actors remain unchanged. Foreign or missing keys and stacks return 404. Requires workspace-level API access management permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^api_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde

string
required
^stack_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde

Body Params

Request body to set all nine permission levels of an API key on one stack, creating the entry when the stack has none yet. Every level is required; this does not change the key's default permissions or scope.

string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
string
enum
required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:
Headers
string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json