Update API key
Update an existing API key for a service account
Path parameters
service_account_user_id
api_key_id
Headers
xi-api-key
Request
This endpoint expects an object.
is_enabled
Whether to enable or disable the API key.
name
The name of the XI API key to use (used for identification purposes only).
permissions
The permissions of the XI API.
character_limit
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_ips
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.
Response
Successful Response
Errors
422
Unprocessable Entity Error