Skip to main content
POST
Create API Key

Authorizations

ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace
string
required

Workspace slug (e.g. staging, production).

Body

application/json
name
string
required

Label for the API key.

Example:

"backend-prod"

description
string | null

Optional notes for operators.

Response

API key created. api_key is returned only once - store it securely.

Workspace-scoped REST API key (server-side secret).

id
string

Unique identifier of the API key.

Example:

"ws_apik_exampleId01"

masked_api_key
string

Masked preview of the API key used in list responses.

Example:

"SS.XXXXXXX*****"

is_deleted
boolean

Indicates whether the API key has been deleted.

name
string

Label for the API key.

Example:

"backend-prod"

allowed_domains
string[]

Domains allowed to use this key.

created_at
string<date-time>

Timestamp when the API key was created.

created_by
object | null

Identity that performed an action (created, updated, rolled, deleted, rotated).

deleted_at
string<date-time> | null

Timestamp when the API key was deleted, if applicable.

deleted_by
object | null

Identity that performed an action (created, updated, rolled, deleted, rotated).

api_key
string

Full secret API key. Returned only once at creation - store it securely and never commit to source control.

Example:

"SS.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"