Skip to Content

API Keys

Manage programmatic API keys for integrations. Available on Pro, Team, and Enterprise tiers.

API Keys management page showing active keys with prefixes and daily limits

API key management requires JWT authentication. You cannot create, list, or revoke keys using another API key.

Create Key

POST /v1/api-keys

Auth: JWT only (Pro tier or above)

Request Body

FieldTypeRequiredDescription
namestringYesDescriptive label for the key (e.g., “CI Pipeline”)

Example

curl -X POST https://cloudsigma.a13e.com/v1/api-keys \ -H "Authorization: Bearer YOUR_JWT_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "CI Pipeline"}'

Response

{ "success": true, "data": { "key": "csk_live_a1b2c3d4e5f67890abcdef1234567890", "prefix": "csk_live_a1b2c3d4", "name": "CI Pipeline", "createdAt": "2026-02-14T10:00:00Z" } }

The full key is shown only once in this response. Store it securely. After this, only the prefix is visible.


List Keys

GET /v1/api-keys

Auth: JWT only

List all API keys for the current user. Returns prefixes and metadata, not full key values.

Example

curl https://cloudsigma.a13e.com/v1/api-keys \ -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response

{ "success": true, "data": { "keys": [ { "prefix": "csk_live_a1b2c3d4", "name": "CI Pipeline", "createdAt": "2026-02-14T10:00:00Z", "lastUsedAt": "2026-02-14T15:30:00Z" } ] } }

Revoke Key

DELETE /v1/api-keys/{prefix}

Auth: JWT only

Permanently revoke an API key. This action cannot be undone.

Path Parameters

ParameterTypeRequiredDescription
prefixstringYesThe key prefix (e.g., csk_live_a1b2c3d4)

Example

curl -X DELETE https://cloudsigma.a13e.com/v1/api-keys/csk_live_a1b2c3d4 \ -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response

{ "success": true, "data": { "message": "API key revoked" } }

Errors

HTTPCodeDescription
401UnauthorizedInvalid or missing JWT token
403ForbiddenAPI key auth not allowed for key management; or Free tier
404NotFoundKey prefix not found
Last updated on