WorkspaceService AccountsAPI Keys

Update API key

Update an existing API key for a service account

Path parameters

service_account_user_idstringRequired
api_key_idstringRequired

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
is_enabledboolean or "no_update"OptionalDefaults to no_update
Whether to enable or disable the API key.
namestring or nullOptional

The name of the XI API key to use (used for identification purposes only).

permissionslist of enums or enumOptionalDefaults to no_update
The permissions of the XI API.
character_limitinteger or "no_update" or nullOptionalDefaults to no_update
The character limit of the XI API key. If provided this will limit the usage of this api key to n characters per month where n is the chosen value. Requests that incur charges will fail after reaching this monthly limit.
allowed_ipslist of strings or enumOptionalDefaults to no_update

List of IP addresses or CIDR ranges allowed to use this API key. Each entry may be a CIDR range (e.g. ‘10.0.0.0/24’) or a bare IP address (normalized to /32 or /128). On create, omit or pass null to allow all IPs. On update, omit to leave the whitelist unchanged, or pass “clear” to remove it.

third_party_disable_allowedboolean or enumOptionalDefaults to no_update

Whether the holder of this key may disable it via the self-disable endpoint. On create, omit or pass null to use the workspace’s default (enabled for non-Enterprise plans, disabled for Enterprise plans). On update, omit to leave it unchanged, or pass “clear” to reset it to the workspace default. Only honored for workspaces with self-disable access enabled.

Response

Successful Response

Errors

422
Unprocessable Entity Error