Docs Get API key

API Reference

The Endpointwise management API lets you create gateways, manage keys, configure routes, and inspect traffic programmatically.

Base URL

https://api.endpointwise.com/v1

Authentication

All management API requests require an account-level API key passed in the Authorization header:

Authorization: Bearer sk_live_your_management_key

Gateways

List gateways

GET /v1/gateways

Returns all gateways in your account.

ParameterTypeRequiredDescription
limitintegeroptionalResults per page. Default: 25. Max: 100.
cursorstringoptionalPagination cursor from previous response.

Create gateway

POST /v1/gateways
Body fieldTypeRequiredDescription
namestringrequiredDisplay name for this gateway.
upstream_urlstringrequiredBase URL of the upstream service.
specstring (YAML/JSON)optionalOpenAPI 3.x spec content. If omitted, configure routes separately.

API Keys

List keys

GET /v1/keys

Returns all API keys. Key values are never returned — only metadata and truncated prefix.

Create key

POST /v1/keys
Body fieldTypeRequiredDescription
namestringrequiredDisplay name (e.g. "Partner: Acme Corp").
scopestringrequiredread, write, admin, or path-specific.
expires_atdateoptionalISO 8601 date. No expiry if omitted.
gateway_idstringoptionalRestrict key to a specific gateway. Defaults to all gateways.

Revoke key

DELETE /v1/keys/{key_id}

Revokes a key immediately. All subsequent requests using this key return 401.

Routes

List routes for a gateway

GET /v1/gateways/{gateway_id}/routes

Update route config

POST /v1/gateways/{gateway_id}/routes/{route_id}

Update rate limit config for a single route without re-pushing the full spec.

Error format

All errors follow a consistent schema:

{
  "error": "validation_failed",
  "message": "The field 'scope' is required.",
  "field": "scope",
  "request_id": "req_01abc"
}