Api Key Rate Limit

The api key rate limit resource.

Basehttps://rest.carbon.ms/apiKeyRateLimit

GET/apiKeyRateLimit

List api key rate limits

Retrieve a paginated list of api key rate limits. 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/apiKeyRateLimit

curl --request GET \
  --url 'https://rest.carbon.ms/apiKeyRateLimit?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "apiKeyId": "xyz789",
    "windowStart": "2026-01-01T00:00:00Z",
    "requestCount": 10
  }
]

GET/apiKeyRateLimit

Retrieve a api key rate limit

Fetch a single api key rate limit by filtering on `apiKeyId`.

Query parameters

apiKeyIdstring

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

GEThttps://rest.carbon.ms/apiKeyRateLimit

curl --request GET \
  --url 'https://rest.carbon.ms/apiKeyRateLimit?apiKeyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "apiKeyId": "xyz789",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

POST/apiKeyRateLimit

Create a api key rate limit

Create a new api key rate limit.

Body parameters

requestCountnumberrequired

POSThttps://rest.carbon.ms/apiKeyRateLimit

curl --request POST \
  --url https://rest.carbon.ms/apiKeyRateLimit \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"requestCount":10}'

Response

{
  "apiKeyId": "xyz789",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

PATCH/apiKeyRateLimit

Update a api key rate limit

Update an existing api key rate limit, matched on `apiKeyId`.

Body parameters

requestCountnumberrequired

PATCHhttps://rest.carbon.ms/apiKeyRateLimit

curl --request PATCH \
  --url 'https://rest.carbon.ms/apiKeyRateLimit?apiKeyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"requestCount":10}'

Response

{
  "apiKeyId": "xyz789",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

DELETE/apiKeyRateLimit

Delete a api key rate limit

Delete a api key rate limit, matched on `apiKeyId`. Returns 204 No Content.

Query parameters

apiKeyIdstring

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

DELETEhttps://rest.carbon.ms/apiKeyRateLimit

curl --request DELETE \
  --url 'https://rest.carbon.ms/apiKeyRateLimit?apiKeyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content