PATCH/api-keys/{api_key_id}

Update an API key

Updates the name of an existing API key. Supply the new name in the request body and the key's ID in the path. The response identifies the updated API key.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
api_key_idstringrequired
The ID of the API key to update.

API key update details.

namestringrequired
The API key name.

1 status code
200Returns an object containing the updated API key's ID.
objectstringoptional
The type of object.
idstringoptional
The ID of the API key.

Error handling

name is required. The api_key_id path parameter must identify an existing API key.