Skip to content

API Keys

Manage API keys for the authenticated user.

These endpoints are not available via OAuth — they require a session or API-key credential. The key value (token) is returned only when the key is created; it is never returned again.

List API Keys

GET /api/api_keys

Returned Params
  • api_keys: Array<Object>
    • id: Integer
    • name: String
    • created_at: DateTime
    • updated_at: DateTime

View an API Key

GET /api/api_keys/:id

Returned Params
  • api_key: Object
    • id: Integer
    • name: String
    • created_at: DateTime
    • updated_at: DateTime

Create an API Key

POST /api/api_keys

Created keys are always non-admin and not system-managed.

Params
  • api_key: Object
    • name: String
Returned Params
  • api_key: Object
    • id: Integer
    • name: String
    • token: String | Returned only on creation — store it now.
    • created_at: DateTime
    • updated_at: DateTime

Rename an API Key

PATCH /api/api_keys/:id

Params
  • api_key: Object
    • name: String

Delete an API Key

DELETE /api/api_keys/:id

Returns 202.