v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Create Workspace Public Key

Create a new public key for this workspace. Public keys can be safely distributed to client SDKs.

post/v1/{workspace}/ws_public_key/

Path parameters

workspacestring required

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

Request body

namestring required

Label for the public key.

descriptionstring nullable

Optional notes.

Example request

{
  "name": "web-app"
}

Response

Public key created.

idstring

Unique identifier of the public key.

api_keystring

Public key value exposed to clients.

namestring

Label for the public key.

allowed_domainsstring[] nullable

Domains allowed to use this public key.

is_secure_mode_enabledboolean

Indicates whether secure mode is enabled for this key.

is_deletedboolean

Indicates whether the public key has been deleted.

is_defaultboolean

Indicates whether this is the default public key for the workspace.

created_atstring date-time

Timestamp when the public key was created.

rotated_atstring date-time nullable

Timestamp when the public key was last rotated.

updated_atstring date-time

Timestamp when the public key was last updated.

Example response

{
  "id": "ws_pubk_exampleId01",
  "api_key": "SS.PUBK.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "name": "web-app",
  "created_by": {
    "name": "System User",
    "email": "user@example.com"
  },
  "rotated_by": {
    "name": "System User",
    "email": "user@example.com"
  },
  "updated_by": {
    "name": "System User",
    "email": "user@example.com"
  }
}