Skip to main content
Create a user-scoped API key for the PIN API. Give it a name to tell it apart from your other keys. The full key value appears only in this response and cannot be retrieved later.

Endpoint

POST /v1/apikeys Authentication: Bearer API key

Request body

string
default:"default"
Name for the new key.

Response

string
Unique key identifier.
string
Name assigned to the key.
string
Full plaintext API key. Store it now; it is not shown again.
string
ISO 8601 timestamp when the key was created.

Example

Create an API key for programmatic access. Pass a name to identify it. The full key value is returned once and cannot be retrieved again.

Endpoint

Authentication

Requires a valid Authorization: Bearer <jwt-or-api-key> header.

Request Body

string
required
Name for the new API key.

Response

string
Id of the created API key.
string
Name from the request.
string
Full API key value. Shown once, so store it securely.