API Keys

List API keys

GET /api/keys

Returns all API keys for your organization. Key values are masked after creation.

Response 200 OK

[
  {
    "id": "key_001",
    "name": "CI/CD Pipeline",
    "prefix": "tp_live_abc1",
    "createdAt": "2025-01-05T09:00:00Z",
    "lastUsedAt": "2025-02-14T15:30:00Z"
  }
]

Create API key

POST /api/keys

Creates a new API key. The full key value is only returned once at creation time.

Request body

FieldTypeRequiredDescription
namestringYesA descriptive name for the key

Response 201 Created

{
  "id": "key_002",
  "name": "GitHub Actions",
  "key": "tp_live_abc123def456ghi789",
  "prefix": "tp_live_abc1",
  "createdAt": "2025-02-16T10:00:00Z"
}

Save the key value immediately - it cannot be retrieved again.

Revoke API key

DELETE /api/keys/:id

Permanently revokes an API key. Any integrations using this key will stop working.

Response 204 No Content

On this page