Carbon

Api Key

The api key resource.

Basehttps://rest.carbon.ms/apiKey
GET/apiKey

List api keys

Retrieve a paginated list of api keys. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/apiKey
curl --request GET \
  --url 'https://rest.carbon.ms/apiKey?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "keyHash": "string",
    "scopes": "string",
    "rateLimit": 0
  }
]
GET/apiKey

Retrieve a api key

Fetch a single api key by filtering on `id`.

Query parameters

idstring

Match on the api key's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/apiKey
curl --request GET \
  --url 'https://rest.carbon.ms/apiKey?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "keyHash": "string",
  "scopes": "string",
  "rateLimit": 0
}
POST/apiKey

Create a api key

Create a new api key.

Body parameters

namestringrequired
companyIdstringrequired

References company.id

keyHashstringrequired
keyPreviewstring
scopesobjectrequired
rateLimitnumberrequired
rateLimitWindowstringrequired
expiresAttimestamp
lastUsedAttimestamp
POSThttps://rest.carbon.ms/apiKey
curl --request POST \
  --url https://rest.carbon.ms/apiKey \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","companyId":"xyz789","keyHash":"string","scopes":"string","rateLimit":0,"rateLimitWindow":"string"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "keyHash": "string",
  "scopes": "string",
  "rateLimit": 0
}
PATCH/apiKey

Update a api key

Update an existing api key, matched on `id`.

Body parameters

namestringrequired
companyIdstringrequired

References company.id

keyHashstringrequired
keyPreviewstring
scopesobjectrequired
rateLimitnumberrequired
rateLimitWindowstringrequired
expiresAttimestamp
lastUsedAttimestamp
PATCHhttps://rest.carbon.ms/apiKey
curl --request PATCH \
  --url 'https://rest.carbon.ms/apiKey?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "keyHash": "string",
  "scopes": "string",
  "rateLimit": 0
}
DELETE/apiKey

Delete a api key

Delete a api key, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the api key to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/apiKey
curl --request DELETE \
  --url 'https://rest.carbon.ms/apiKey?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content