Admin

List Routes

get

List all service routes.

Query parameters

enabled_onlybooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/routes

HTTPcURLJavaScriptPython

GET /admin/routes HTTP/1.1
Host: 
Accept: */*

No content

Create Route

post

Create a new service route.

Body

application/json

service_namestringRequired

urlstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

quota_limitintegerOptionalDefault: 500

quota_unitstringOptionalDefault: requests/min

health_endpointany ofOptional

stringOptional

or

nullOptional

docs_endpointany ofOptional

stringOptional

or

nullOptional

redoc_endpointany ofOptional

stringOptional

or

nullOptional

openapi_endpointany ofOptional

stringOptional

or

nullOptional

api_pathany ofOptional

stringOptional

or

nullOptional

path_transformationany ofOptional

stringOptional

or

nullOptional

enabledbooleanOptionalDefault: true

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/admin/routes

HTTPcURLJavaScriptPython

POST /admin/routes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "service_name": "text",
  "url": "text",
  "description": "text",
  "quota_limit": 500,
  "quota_unit": "requests/min",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "enabled": true
}

No content

Get Route

get

Get a specific route.

Path parameters

route_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/routes/{route_id}

HTTPcURLJavaScriptPython

GET /admin/routes/{route_id} HTTP/1.1
Host: 
Accept: */*

No content

Update Route

put

Update a route.

Path parameters

route_idstringRequired

Body

application/json

urlany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

quota_limitany ofOptional

integerOptional

or

nullOptional

quota_unitany ofOptional

stringOptional

or

nullOptional

health_endpointany ofOptional

stringOptional

or

nullOptional

docs_endpointany ofOptional

stringOptional

or

nullOptional

redoc_endpointany ofOptional

stringOptional

or

nullOptional

openapi_endpointany ofOptional

stringOptional

or

nullOptional

api_pathany ofOptional

stringOptional

or

nullOptional

path_transformationany ofOptional

stringOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/admin/routes/{route_id}

HTTPcURLJavaScriptPython

PUT /admin/routes/{route_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "url": "text",
  "description": "text",
  "quota_limit": 1,
  "quota_unit": "text",
  "health_endpoint": "text",
  "docs_endpoint": "text",
  "redoc_endpoint": "text",
  "openapi_endpoint": "text",
  "api_path": "text",
  "path_transformation": "text",
  "enabled": true
}

No content

Delete Route

delete

Delete a route.

Path parameters

route_idstringRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/admin/routes/{route_id}

HTTPcURLJavaScriptPython

DELETE /admin/routes/{route_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Route By Service

get

Get route for a specific service.

Path parameters

service_namestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/routes/service/{service_name}

HTTPcURLJavaScriptPython

GET /admin/routes/service/{service_name} HTTP/1.1
Host: 
Accept: */*

No content

Toggle Route

post

Enable or disable a route.

Path parameters

route_idstringRequired

Query parameters

enabledbooleanRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/admin/routes/{route_id}/toggle

HTTPcURLJavaScriptPython

POST /admin/routes/{route_id}/toggle?enabled=true HTTP/1.1
Host: 
Accept: */*

No content

List Policies

get

List all policies.

Query parameters

enabled_onlybooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/policies

HTTPcURLJavaScriptPython

GET /admin/policies HTTP/1.1
Host: 
Accept: */*

No content

Create Policy

post

Create a new service policy.

Body

application/json

service_namestringRequired

policy_typestringRequired

enabledbooleanOptionalDefault: true

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/admin/policies

HTTPcURLJavaScriptPython

POST /admin/policies HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "service_name": "text",
  "policy_type": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

No content

Get Policy

get

Get a specific policy.

Path parameters

policy_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

GET /admin/policies/{policy_id} HTTP/1.1
Host: 
Accept: */*

No content

Update Policy

put

Update a policy.

Path parameters

policy_idstringRequired

Body

application/json

configany ofOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

PUT /admin/policies/{policy_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enabled": true
}

No content

Delete Policy

delete

Delete a policy.

Path parameters

policy_idstringRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/admin/policies/{policy_id}

HTTPcURLJavaScriptPython

DELETE /admin/policies/{policy_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Policies By Service

get

Get all policies for a service.

Path parameters

service_namestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/policies/service/{service_name}

HTTPcURLJavaScriptPython

GET /admin/policies/service/{service_name} HTTP/1.1
Host: 
Accept: */*

No content

Toggle Policy

post

Enable or disable a policy.

Path parameters

policy_idstringRequired

Query parameters

enabledbooleanRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/admin/policies/{policy_id}/toggle

HTTPcURLJavaScriptPython

POST /admin/policies/{policy_id}/toggle?enabled=true HTTP/1.1
Host: 
Accept: */*

No content

Get Rate Limit Status

get

Get rate limiting status and metrics.

Returns: - enabled: Whether rate limiting is enabled - mode: Current mode (enforce/shadow/disabled) - metrics: Rate limiter metrics - backend: Which backend is active (redis/memory/noop)

Responses

200

Successful Response

application/json

Responseany

get

/admin/rate-limits/status

HTTPcURLJavaScriptPython

GET /admin/rate-limits/status HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Get Rate Limit Usage

get

Get current rate limit usage for an entity.

Args: entity_type: Type of entity (team, user, apikey) entity_id: Entity identifier service_name: Service to check (default: all) window_seconds: Window size in seconds

Returns: Current usage count

Path parameters

entity_typestringRequired

entity_idstringRequired

Query parameters

service_namestringOptionalDefault: all

window_secondsintegerOptionalDefault: 60

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/admin/rate-limits/usage/{entity_type}/{entity_id}

HTTPcURLJavaScriptPython

GET /admin/rate-limits/usage/{entity_type}/{entity_id} HTTP/1.1
Host: 
Accept: */*

No content

Reset Rate Limit

post

Reset rate limit counter for an entity.

Use with caution - this allows the entity to immediately make more requests.

Args: entity_type: Type of entity (team, user, apikey) entity_id: Entity identifier service_name: Service to reset (default: all)

Returns: Success status

Path parameters

entity_typestringRequired

entity_idstringRequired

Query parameters

service_namestringOptionalDefault: all

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/admin/rate-limits/reset/{entity_type}/{entity_id}

HTTPcURLJavaScriptPython

POST /admin/rate-limits/reset/{entity_type}/{entity_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Rate Limit Health

get

Check health of rate limiting backend.

Returns: - healthy: Whether the backend is available - backend: Which backend is active - redis_available: Redis connectivity status

Responses

200

Successful Response

application/json

Responseany

get

/admin/rate-limits/health

HTTPcURLJavaScriptPython

GET /admin/rate-limits/health HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content