Rate Limits

GET/admin/rate-limits

Get the full rate limit configuration

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits"

{  "default_tier": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "max_requests": 0,    "name": "string",    "tier_type": "default",    "updated_at": "2019-08-24T14:15:22Z",    "window_seconds": 0  },  "endpoint_tiers": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "max_requests": 0,      "name": "string",      "tier_type": "default",      "updated_at": "2019-08-24T14:15:22Z",      "window_seconds": 0    }  ],  "support_tiers": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "max_requests": 0,      "name": "string",      "updated_at": "2019-08-24T14:15:22Z",      "window_seconds": 0    }  ],  "user_count": 0}

POST/admin/rate-limits/cache/clear

Clear the rate limit configuration cache

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Response Body

curl -X POST "https://example.com/admin/rate-limits/cache/clear"

Empty

GET/admin/rate-limits/support-tiers

List all support tiers

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query

page?integer

Page number (1-based)

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/support-tiers"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "tiers": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "max_requests": 0,      "name": "string",      "updated_at": "2019-08-24T14:15:22Z",      "window_seconds": 0    }  ]}

POST/admin/rate-limits/support-tiers

Create a support tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create a support tier

description?|

Description of the tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

name*string

Tier name (e.g., "basic", "premium", "enterprise", "vip")

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/admin/rate-limits/support-tiers" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "name": "string",    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "max_requests": 0,  "name": "string",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/support-tiers/{tier_name}

Get a support tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

tier_name*string

Tier name

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/support-tiers/string"

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "max_requests": 0,  "name": "string",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

DELETE/admin/rate-limits/support-tiers/{tier_name}

Delete a support tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

tier_name*string

Tier name

Response Body

curl -X DELETE "https://example.com/admin/rate-limits/support-tiers/string"

Empty

PUT/admin/rate-limits/support-tiers/{tier_name}

Update a support tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

tier_name*string

Tier name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update a support tier

description?|

Description of the tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/admin/rate-limits/support-tiers/string" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "max_requests": 0,  "name": "string",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/tiers/default

Get the default rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/tiers/default"

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

PUT/admin/rate-limits/tiers/default

Update the default rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update the default rate limit tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/admin/rate-limits/tiers/default" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/tiers/endpoints

List all endpoint rate limit tiers

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

tier_type?string

Filter by tier type (default, endpoint)

q?string

Full-text search query

page?integer

Page number (1-based)

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/tiers/endpoints"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "tiers": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "max_requests": 0,      "name": "string",      "tier_type": "default",      "updated_at": "2019-08-24T14:15:22Z",      "window_seconds": 0    }  ]}

POST/admin/rate-limits/tiers/endpoints

Create an endpoint rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create an endpoint rate limit tier

endpoint_path*string

Endpoint path (e.g., "/api/v1/geo/update")

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/admin/rate-limits/tiers/endpoints" \  -H "Content-Type: application/json" \  -d '{    "endpoint_path": "string",    "max_requests": 0,    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/tiers/endpoints/{endpoint_path}

Get an endpoint rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

endpoint_path*string

Endpoint path

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/tiers/endpoints/string"

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

DELETE/admin/rate-limits/tiers/endpoints/{endpoint_path}

Delete an endpoint rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

endpoint_path*string

Endpoint path

Response Body

curl -X DELETE "https://example.com/admin/rate-limits/tiers/endpoints/string"

Empty

PUT/admin/rate-limits/tiers/endpoints/{endpoint_path}

Update an endpoint rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

endpoint_path*string

Endpoint path

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update an endpoint rate limit tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/admin/rate-limits/tiers/endpoints/string" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/tiers/modules

List all module rate limit tiers

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

tier_type?string

Filter by tier type (default, endpoint)

q?string

Full-text search query

page?integer

Page number (1-based)

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/tiers/modules"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "tiers": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "max_requests": 0,      "name": "string",      "tier_type": "default",      "updated_at": "2019-08-24T14:15:22Z",      "window_seconds": 0    }  ]}

POST/admin/rate-limits/tiers/modules

Create a module rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create a module rate limit tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

module*string

Module name (e.g., "geo", "job_queue", "webhook")

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/admin/rate-limits/tiers/modules" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "module": "string",    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/tiers/modules/{module}

Get a module rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

module*string

Module name

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/tiers/modules/string"

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

DELETE/admin/rate-limits/tiers/modules/{module}

Delete a module rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

module*string

Module name

Response Body

curl -X DELETE "https://example.com/admin/rate-limits/tiers/modules/string"

Empty

PUT/admin/rate-limits/tiers/modules/{module}

Update a module rate limit tier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

module*string

Module name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update a module rate limit tier

max_requests*integer

Maximum requests allowed in the window

Formatint32

Range0 <= value

window_seconds*integer

Time window in seconds (1 second to 24 hours)

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/admin/rate-limits/tiers/modules/string" \  -H "Content-Type: application/json" \  -d '{    "max_requests": 0,    "window_seconds": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "max_requests": 0,  "name": "string",  "tier_type": "default",  "updated_at": "2019-08-24T14:15:22Z",  "window_seconds": 0}

GET/admin/rate-limits/users

List all user rate limit configurations

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

tier?string

Filter by tier name

bypass?boolean

Filter by bypass status

q?string

Full-text search query

page?integer

Page number (1-based)

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/users"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "users": [    {      "bypass": true,      "created_at": "2019-08-24T14:15:22Z",      "custom_limits": {        "property1": {          "max_requests": 0,          "window_seconds": 0        },        "property2": {          "max_requests": 0,          "window_seconds": 0        }      },      "tier": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ]}

POST/admin/rate-limits/users

Create a user rate limit configuration

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create a user rate limit configuration

bypass?boolean

Whether to bypass rate limiting entirely

custom_limits?|

Custom per-endpoint limits for this user

tier*string

Support tier name (e.g., "basic", "premium", "enterprise")

user_id*string

User ID to configure

Response Body

`application/json`

curl -X POST "https://example.com/admin/rate-limits/users" \  -H "Content-Type: application/json" \  -d '{    "tier": "string",    "user_id": "string"  }'

{  "bypass": true,  "created_at": "2019-08-24T14:15:22Z",  "custom_limits": {    "property1": {      "max_requests": 0,      "window_seconds": 0    },    "property2": {      "max_requests": 0,      "window_seconds": 0    }  },  "tier": "string",  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string"}

GET/admin/rate-limits/users/{user_id}

Get a user's rate limit configuration

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

User ID

Response Body

`application/json`

curl -X GET "https://example.com/admin/rate-limits/users/string"

{  "bypass": true,  "created_at": "2019-08-24T14:15:22Z",  "custom_limits": {    "property1": {      "max_requests": 0,      "window_seconds": 0    },    "property2": {      "max_requests": 0,      "window_seconds": 0    }  },  "tier": "string",  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string"}

DELETE/admin/rate-limits/users/{user_id}

Delete a user's rate limit configuration

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

User ID

Response Body

curl -X DELETE "https://example.com/admin/rate-limits/users/string"

Empty

PUT/admin/rate-limits/users/{user_id}

Update a user's rate limit configuration

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

User ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update a user rate limit configuration

bypass?boolean

Whether to bypass rate limiting entirely

custom_limits?|

Custom per-endpoint limits for this user

tier?|

Support tier name (e.g., "basic", "premium", "enterprise")

Response Body

`application/json`

curl -X PUT "https://example.com/admin/rate-limits/users/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "bypass": true,  "created_at": "2019-08-24T14:15:22Z",  "custom_limits": {    "property1": {      "max_requests": 0,      "window_seconds": 0    },    "property2": {      "max_requests": 0,      "window_seconds": 0    }  },  "tier": "string",  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string"}

GET/api/v1/rate-limits/me

Get the calling principal's effective rate limit budget. Any authenticated user may read their own limits; no admin role required.

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

endpoint?string

Endpoint to resolve the limit against (defaults to the global budget)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rate-limits/me"

{  "bypass": true,  "endpoint": "string",  "endpoint_override_active": true,  "limit": 0,  "principal_id": "string",  "window_seconds": 0}

Rate Limits

200application/json

401

403

204

401

403

200application/json

401

201application/json

400

401

403

409

200application/json

401

404

204

400

401

403

404

200application/json

400

401

403

404

200application/json

401

200application/json

400

401

403

200application/json

401

201application/json

400

401

403

409

200application/json

401

404

204

401

403

404

200application/json

400

401

403

404

200application/json

401

201application/json

400

401

403

409

200application/json

401

404

204

401

403

404

200application/json

400

401

403

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`