Skip to main content
POST
/
v1
/
{workspace}
/
ws_api_key
Create API Key
curl -X POST "https://management-api.suprsend.com/v1/{workspace}/ws_api_key/" \
  --header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"backend-prod","description":"Primary backend key"}'
{
  "id": "ws_apik_exampleId01",
  "masked_api_key": "SS.XXXXXXX*****",
  "is_deleted": false,
  "name": "backend-prod",
  "allowed_domains": [],
  "created_at": "2026-04-21T12:19:00.148846Z",
  "created_by": {
    "name": "System User",
    "email": "org_XXXXXXXXXXXXXXXXXXXXXX@systemuser.suprsend.com"
  },
  "deleted_at": null,
  "deleted_by": null,
  "api_key": "SS.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Documentation Index

Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt

Use this file to discover all available pages before exploring further.

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
Example:

"ws_apik_exampleId01"

​
masked_api_key
string

Masked preview of the API key used in list responses.

Example:

"SS.XXXXXXX*****"

​
is_deleted
boolean
​
name
string
Example:

"backend-prod"

​
allowed_domains
string[]

Domains allowed to use this key.

​
created_at
string<date-time>
​
created_by
object

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

​
deleted_at
string<date-time> | null
​
deleted_by
object

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"