Create API key

Creates a new 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
Specify the ID of the API client to create the API key for.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired
Name of the API key.
activebooleanRequired
Indicates whether the API key is enabled or disabled. Disabled keys cannot call any APIs.
ip_allow_listlist of stringsOptional
List of IP addresses to add to the allowlist.
ip_deny_listlist of stringsOptional
List of IP addresses to deny requests from.

Response

Success - The API key was created successfully.

dataobject or null

Errors