v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

manage

Update an API key's user-supplied label.

patch/manage/api/api_keys/{api_key_id}

Path parameters

api_key_idstring required

The ID of API key to operate on. Expected to be a URL safe Base64 encoded UUID.

Request body

labelstring nullable

New label for the API key. Pass null (or omit) to clear the existing label.

Example request

{
  "label": "Live production environment"
}

Response

The updated API key.

api_key_idstring required

Base64 encoded API key ID

redacted_api_keystring required

A redacted text snippet of the API key. Contains the first 4 characters of the API key

creation_timestring date-time required

The date at which the API key was created

status'ACTIVE' | 'DISABLED' required

Status of the API key

labelstring nullable

An optional user-supplied label for managing the API key

Example response

{
  "creation_time": "2000-01-23T04:56:07+00:00",
  "label": "Live production environment",
  "redacted_api_key": "ATG56•••••••••••••",
  "api_key_id": "JRPVD7jWR1aTBYiJ0UFVOg",
  "status": null
}