Update API key

Update an existing API key for a service account

Path parameters

service_account_user_idstringRequired
api_key_idstringRequired

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
is_enabledbooleanRequired
Whether to enable or disable the API key.
namestringRequired

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

permissionslist of enums or "all"Required
The permissions of the XI API.
character_limitinteger or nullOptional
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.

Response

Successful Response

Errors