Skip to content

API Keys

Manage your API keys programmatically. You can also create and delete keys from your API Keys page.

API Keys management page

Create Your First API Key

POST /apikeys

ParameterTypeRequiredDescription
namestringNoLabel for the key (e.g. "Production"). Defaults to "Default".

Response 201 Created

json
{
  "apiKey": "bws_a1b2c3d4e5f6789012345678abcdef01",
  "keyPrefix": "bws_a1b2c3d4",
  "keyName": "Production",
  "createdAt": 1711036800000,
  "expiresAt": 1742572800000
}

WARNING

The full API key is only returned once at creation. Store it securely.

List API Keys

GET /apikeys

json
[
  {
    "keyPrefix": "bws_a1b2c3d4",
    "keyName": "Production",
    "createdAt": 1711036800000,
    "expiresAt": 1742572800000,
    "lastUsedAt": 1711123200000
  }
]

Delete API Key

DELETE /apikeys/:key

ParameterTypeRequiredDescription
keystringYesThe full API key or key prefix to delete.