Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
workspace

Edit Service Account Api Key

Update an existing API key for a service account

patch/v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}

Path parameters

service_account_user_idstring required
api_key_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring nullable

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

Example request

{
  "name": "Sneaky Fox"
}

Response

Successful Response

{"stackTrail":"paths:/v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}