Create API key

Creates a new API key for programmatic access to the system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

If true, omit properties with null values.

Body Params

Carries the data required to provision a new API key associated with a user or service account. Includes metadata such as a friendly name, activation flag, and optional expiration to enforce key rotation and lifecycle policies.

string
required
length between 1 and 32

A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service')

boolean

Whether the key should be active upon creation. Inactive keys cannot authenticate.

date-time | null

Optional UTC timestamp after which the key is considered expired and rejected

string | null

The raw API key value to be created/registered. If omitted, the server may generate it.

uuid

Identifier of the user (or owner) the key belongs to

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json