API ReferenceChangelog
Log In
API Reference

Create a new API key

Creates a new API key associated with the authenticated user. API keys are used for authentication when accessing the Pixop API.

Each user can have up to 2 active API keys. If this limit is reached, attempts to create an additional active API key will result in a 409 Conflict response.

Note

  • API keys become eligible for automatic deletion if they are not used for authentication for 90 consecutive days.
    Using a key successfully resets this 90-day inactivity window, but the key may become eligible for deletion again after a later period of inactivity.
  • When a key becomes eligible for deletion, the deletionEligibleAt field will indicate the earliest date on which it may be deleted.
Body Params

Fields required for creating a new API key.

Represents the fields that can be updated for an existing API key.

string
required
length between 1 and 47

A user-defined name to associate with the API key.

string
length between 1 and 255

A user-defined description of the API key, providing additional context or details about its purpose or usage.

boolean
required

Indicates whether this API key is active and can be used for authentication. An inactive API key cannot be used to access the platform's services.

Responses

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