Request Limit

The request limit resource.

Base/requestLimit

GET/requestLimit

List request limits

Retrieve a paginated list of request 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.

GET/requestLimit

curl --request GET \
  --url '<your-host>/requestLimit?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

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

GET/requestLimit

Retrieve a request limit

Fetch a single request limit by filtering on `key`.

Query parameters

keystring

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

GET/requestLimit

curl --request GET \
  --url '<your-host>/requestLimit?key=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "key": "string",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

POST/requestLimit

Create a request limit

Create a new request limit.

Body parameters

requestCountnumberrequired

POST/requestLimit

curl --request POST \
  --url <your-host>/requestLimit \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"requestCount":10}'

Response

{
  "key": "string",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

PATCH/requestLimit

Update a request limit

Update an existing request limit, matched on `key`.

Body parameters

requestCountnumberrequired

PATCH/requestLimit

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

Response

{
  "key": "string",
  "windowStart": "2026-01-01T00:00:00Z",
  "requestCount": 10
}

DELETE/requestLimit

Delete a request limit

Delete a request limit, matched on `key`. Returns 204 No Content.

Query parameters

keystring

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

DELETE/requestLimit

curl --request DELETE \
  --url '<your-host>/requestLimit?key=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content