Embedded APIResourcesAPI platform

Update API key

Updates an existing API key for an API client.

Path parameters

idstringRequired

Embedded customer ID/external ID. The external ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.

api_client_idstringRequired
ID of the API client associated with the API key.
api_key_idstringRequired
ID of the API key to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional
Updated name of the API key.
ip_allow_listlist of stringsOptional
Updated list of IP addresses to allow requests from.
ip_deny_listlist of stringsOptional
Updated list of IP addresses to deny requests from.

Response

Success - The API key was updated successfully.

dataobject or null

Errors