Set API key default stack permissions

Replaces all nine stored default stack levels of an active workspace-managed key in any scope. Existing stack permissions, workspace permissions, credentials, name, description, expiry and ownership remain unchanged. Stack permissions still replace defaults on their stacks; unlisted stacks use the new default. User-owned or inactive targets return 403. Equal normalized levels write nothing. Optional If-Match uses getWorkspaceApiKeyPermissionConfiguration's validator under the key lock, with current authorization rechecked after waits. The complete configuration response omits ETag; GET it again for the next validator. Foreign/missing keys 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

Body Params

Request body to replace all nine configured default stack permission levels of an active workspace-managed API key. Every level is required; workspace permissions, scope and stack permissions remain unchanged.

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