Skip to main content

​
Endpoint

GET /api-keys/list
Auth: API Key or Session

​
Response

{
  "success": true,
  "keys": [
    {
      "id": "key_abc123",
      "name": "production",
      "start": "oink_xxx",
      "prefix": "oink_",
      "enabled": true,
      "expiresAt": "2025-03-15T10:30:00.000Z",
      "createdAt": "2024-03-15T10:30:00.000Z",
      "updatedAt": "2024-03-15T10:30:00.000Z",
      "remaining": null,
      "rateLimitEnabled": false
    }
  ]
}
​
keys
array
Status codes: 200 success · 401 unauthorized · 500 error

​
Example

curl http://localhost:3000/api-keys/list \
  -H "Authorization: Bearer <api_key>"

Create API Key

Generate a new key.

Update API Key

Rename or enable/disable a key.

Delete API Key

Revoke a key permanently.