Skip to main content
POST
/
api
/
v2
/
api-keys
/
{
  "id": "<string>",
  "customer_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "public_key": "<string>",
  "private_key_display": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_revoked": false,
  "revoked_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "environment": "<string>",
  "private_key": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token from Auth0 authentication

Body

application/json

Request model for creating a new API key (V2).

​
name
string
required

A user-friendly name for the API key.

Required string length: 1 - 100
​
description
string | null

An optional description for the API key.

Maximum length: 255

Response

Successful Response

V2 API Key Create Response - uses private_key field name (same as V1). V2 may include additional validation or fields in the future.

​
id
string
required
​
customer_id
string
required
​
name
string
required
​
public_key
string
required
​
private_key_display
string
required
​
created_at
string<date-time>
required
​
private_key
string
required

The private key for authentication

​
description
string | null
​
is_revoked
boolean
default:false
​
revoked_at
string<date-time> | null
​
last_used_at
string<date-time> | null
​
environment
string | null
⌘I