openapi: 3.2.0 info: title: KnoxCall Client Management Clients API version: '1.0' description: 'The KnoxCall Client Management API provides programmatic access to manage your API gateway resources including routes, secrets, clients, environments, webhooks, and API keys. ## Authentication All requests must include an OAuth 2.1 access token **or** a legacy API key. The recommended path for new integrations is the first-party SDKs, which mint, cache, and refresh OAuth tokens for you (start with `knoxcall login` on a developer machine, or `KNOXCALL_CLIENT_ID` / `KNOXCALL_CLIENT_SECRET` in CI). You can authenticate using any of: - **Authorization header (OAuth 2.1 bearer token — recommended)**: `Authorization: Bearer ` - **Authorization header (legacy API key)**: `Authorization: Bearer tk_xxx_yyy` - **x-api-key header (legacy API key)**: `x-api-key: tk_xxx_yyy` OAuth 2.1 access tokens (`kc_` prefix) are minted at the root-host token endpoint `https://api.knoxcall.com/oauth/token` (not under `/v1`) using the `client_credentials` or `authorization_code` grant. See the `OAuth2` security scheme and the `/oauth/*` endpoints. Some resources that are managed exclusively through OAuth reject API-key auth with a `403 use_oauth` error. Long-lived API keys remain fully supported. They come in three types: - **Standard keys** (`tk_` prefix) are used on the production API (`api.knoxcall.com`). - **Test keys** (`tk_` prefix, type=test) are used on the sandbox API (`sandbox.knoxcall.com`). - **Enterprise Access Keys** (`AKE` prefix) follow the format `AKE[16chars]:[40chars]`. Using a test key on the production API (or vice versa) will return a `403 wrong_key_type` error. ## Request IDs Every response — success or error — includes an `X-Request-Id` response header (a UUID). Its value is identical to the `request_id` field in the response body (`meta.request_id` on success, `error.request_id` on error). Quote it when contacting support. ## API Versioning The API is versioned on two axes: - **Major version — the `/v1` path prefix.** Breaking changes ship under a new major (`/v2`). `/v1` never receives a breaking change. - **Minor version — the `KnoxCall-Version` header (dated, `YYYY-MM-DD`).** Send `KnoxCall-Version: 2026-08-05` to pin the behaviour of a specific dated release. Omit the header to get the newest minor version. Every response echoes the resolved version back in a `KnoxCall-Version` response header. Within a major version, **additive changes are not breaking** and may appear without a new dated version: new endpoints, new optional request fields, new response fields, new `error.type` values, and new enum members. Clients must tolerate unknown response fields and unknown `error.type` values (see the `ErrorResponse` schema). An **unknown or malformed** `KnoxCall-Version` value returns `400` with `error.type: invalid_api_version`. ## Rate Limiting API keys can have optional rate limits configured. When a limit is configured, the following headers are emitted on **every** response (not only `429`s): - `X-RateLimit-Limit` -- maximum requests allowed per window - `X-RateLimit-Remaining` -- remaining requests in the current window - `X-RateLimit-Reset` -- epoch seconds at which the window resets When the limit is exceeded the API returns `429` (`rate_limit_exceeded` / `rate_limited`) and additionally sets `Retry-After` (seconds until the window resets). ## DPoP sender-constrained tokens, and the server nonce A token minted with a `cnf.jkt` binding (DPoP, RFC 9449) requires a `DPoP` proof header on every request, signed over the request''s method and canonical public URL. **Every response to a request that carried a `DPoP` header also carries a `DPoP-Nonce` response header** -- mints, refusals and successful calls alike, on `POST /oauth/token`, `/v1`, the tenant data plane, the self-hosted proxy and the AI gateway. The value is stateless and changes every minute; the server accepts the current and the previous minute''s, so a nonce is good for 60-120 seconds.' contact: name: KnoxCall Support url: https://knoxcall.com email: support@knoxcall.com license: name: Proprietary url: https://knoxcall.com/terms servers: - url: https://api.knoxcall.com/v1 description: Production - url: https://sandbox.knoxcall.com/v1 description: Sandbox (test keys only) security: - OAuth2: [] - BearerAuth: [] - ApiKeyAuth: [] tags: - name: Clients description: Manage authorized clients (users or servers) with IP-based access control. paths: /clients: get: operationId: listClients summary: List clients description: Returns a paginated list of authorized clients. tags: - Clients parameters: - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' - name: sort in: query schema: type: string enum: - created_at - name - type - ip_address default: created_at description: Field to sort by. - $ref: '#/components/parameters/OrderParam' - name: type in: query schema: type: string enum: - user - server description: Filter clients by type. responses: '200': description: A paginated list of clients. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Client' meta: $ref: '#/components/schemas/PaginationMeta' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' post: operationId: createClient summary: Create a client description: 'Creates a new authorized client. Clients represent users or servers that are allowed to call your routes. The `ip_address` field supports individual IPs, CIDR notation, and ranges.' tags: - Clients parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateClientRequest' example: name: Production Backend type: server ip_address: 203.0.113.0/24 description: Main backend server pool responses: '200': description: The created client. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClientFull' meta: $ref: '#/components/schemas/RequestMeta' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PlanLimit' '409': $ref: '#/components/responses/ClientNameConflictOrRequestInProgress' '422': $ref: '#/components/responses/IdempotencyKeyReuse' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' /clients/{id}: parameters: - $ref: '#/components/parameters/ClientId' get: operationId: getClient summary: Get client details description: Returns full details of a single client, including its route assignments. tags: - Clients responses: '200': description: Client details with route assignments. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClientDetail' meta: $ref: '#/components/schemas/RequestMeta' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' patch: operationId: updateClient summary: Update a client description: Updates one or more fields on an existing client. Only provided fields are changed. tags: - Clients parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateClientRequest' example: enabled: false description: Disabled for maintenance responses: '200': description: The updated client. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClientFull' meta: $ref: '#/components/schemas/RequestMeta' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/ClientNameConflictOrRequestInProgress' '422': $ref: '#/components/responses/IdempotencyKeyReuse' '500': $ref: '#/components/responses/InternalError' delete: operationId: deleteClient summary: Delete a client description: Permanently deletes a client and removes all of its route assignments. tags: - Clients parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' responses: '200': description: Client deleted. content: application/json: schema: $ref: '#/components/schemas/DeletedResponse' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/RequestInProgress' '422': $ref: '#/components/responses/IdempotencyKeyReuse' '500': $ref: '#/components/responses/InternalError' /clients/{id}/credentials: parameters: - $ref: '#/components/parameters/ClientId' get: operationId: listClientCredentials summary: List client credentials description: 'Returns all credentials attached to a client. Secret material (HMAC secrets, private keys) is redacted from the `data` object.' tags: - Clients responses: '200': description: List of credentials. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ClientCredential' meta: $ref: '#/components/schemas/RequestMeta' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' post: operationId: createClientCredential summary: Create a client credential description: 'Attaches a credential to a client. Supported kinds in v1: `ip` and `mtls_thumbprint`. - `ip` — `data.value` must be an IP address or CIDR range. - `mtls_thumbprint` — either register an existing certificate with `data.sha256_thumbprint` (64 hex chars), or set `data.mode` to `issue` to have KnoxCall mint a client certificate. For the issue mode the response carries a one-shot `reveal` object with the PEM bundle (certificate, private key, CA chain) — **it is returned exactly once and never stored**. A token issued to a person (`knoxcall login`, a device or authorization-code grant) cannot use `mode: issue` and gets **403 `forbidden`**, whatever the person''s role: the response would carry a private key. Register a certificate you generated yourself by its `sha256_thumbprint`, issue it from the dashboard, or use an API key.' tags: - Clients requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateClientCredentialRequest' examples: ip: summary: IP / CIDR credential value: kind: ip label: Office egress data: value: 203.0.113.0/24 mtls_issue: summary: Mint a new mTLS client certificate value: kind: mtls_thumbprint label: Backend pool cert data: mode: issue responses: '200': description: 'The created credential. For `mtls_thumbprint` with `mode: issue`, includes the one-shot `reveal` PEM bundle. ' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClientCredentialCreated' meta: $ref: '#/components/schemas/RequestMeta' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' /clients/{id}/credentials/{credId}: parameters: - $ref: '#/components/parameters/ClientId' - name: credId in: path required: true schema: type: string format: uuid description: The credential UUID. patch: operationId: updateClientCredential summary: Update a client credential description: Updates a credential's `enabled` flag and/or `label`. At least one field is required. tags: - Clients requestBody: required: true content: application/json: schema: type: object properties: enabled: type: boolean label: type: - string - 'null' example: enabled: false responses: '200': description: The updated credential. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClientCredential' meta: $ref: '#/components/schemas/RequestMeta' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' delete: operationId: deleteClientCredential summary: Delete a client credential description: Permanently removes a credential from a client. tags: - Clients responses: '200': description: Credential deleted. content: application/json: schema: $ref: '#/components/schemas/DeletedResponse' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' components: schemas: CreateClientCredentialRequest: type: object required: - kind - data properties: kind: type: string enum: - ip - mtls_thumbprint description: The credential kind. v1 supports `ip` and `mtls_thumbprint`. label: type: string description: Human-readable label. example: Office egress data: type: object description: "Kind-specific data:\n- `ip` — `value` (IP address or CIDR) is required.\n- `mtls_thumbprint` — either `sha256_thumbprint` (register an\n existing certificate) or `mode: issue` (mint a new one).\n" properties: value: type: string description: 'IP address or CIDR range (kind: `ip`).' example: 203.0.113.0/24 sha256_thumbprint: type: string description: 'SHA-256 hex digest of an existing client certificate, 64 hex chars (kind: `mtls_thumbprint`).' mode: type: string enum: - issue description: 'Set to `issue` to have KnoxCall mint a client certificate (kind: `mtls_thumbprint`).' RequestMeta: type: object description: Metadata included with every API response. properties: request_id: type: string format: uuid description: Unique identifier for this API request, useful for support and debugging. example: 550e8400-e29b-41d4-a716-446655440000 required: - request_id CreateClientRequest: type: object required: - name - ip_address properties: name: type: string description: Human-readable name for the client. example: Production Backend type: type: string enum: - user - server description: Client type. Defaults to `server` if not specified. default: server example: server ip_address: type: string description: 'IP address or CIDR range to authorize. Supports individual IPs (e.g. `203.0.113.42`), CIDR notation (e.g. `203.0.113.0/24`), and IPv6 addresses. ' example: 203.0.113.0/24 description: type: string description: Optional description. example: Main backend server pool ClientCredentialCreated: allOf: - $ref: '#/components/schemas/ClientCredential' - type: object properties: reveal: type: object description: 'One-shot PEM bundle, present only for `mtls_thumbprint` with `mode: issue`. **Returned exactly once and never stored.**' properties: certificate_pem: type: string description: The issued client certificate (PEM). private_key_pem: type: string description: The certificate's private key (PEM). **Shown only in this response.** ca_chain_pem: type: string description: The issuing CA chain (PEM). Client: type: object description: An authorized client (user or server) with IP-based access control. properties: id: type: string format: uuid example: b8d2e9f4-3a5c-4d7b-9e0f-2a4c6b8d0e1f name: type: string description: Human-readable name for the client. example: Production Backend type: type: string enum: - user - server description: Client type -- `user` for individual users, `server` for backend services. example: server ip_address: type: string description: IP address, CIDR range, or IP range authorized for this client. example: 203.0.113.0/24 ip_notes: type: object additionalProperties: true description: Notes about the IP address configuration, keyed by IP. description: type: - string - 'null' description: Optional description of the client. example: Main backend server pool enabled: type: boolean description: Whether the client is active. example: true collection_id: type: - string - 'null' format: uuid description: Collection this client belongs to, if any. created_at: type: string format: date-time example: '2025-03-15T10:30:00.000Z' updated_at: type: string format: date-time example: '2025-03-16T08:00:00.000Z' PaginationMeta: type: object description: Pagination metadata for list endpoints. properties: total: type: integer description: Total number of records matching the query. example: 42 page: type: integer description: Current page number. example: 1 per_page: type: integer description: Number of records per page. example: 20 total_pages: type: integer description: Total number of pages, capped at the deepest page the 100,000-row offset ceiling allows -- `min(ceil(total / per_page), floor(100000 / per_page) + 1)`. When it is below `ceil(total / per_page)` the result set is larger than pagination can reach; narrow it with a filter. example: 3 request_id: type: string format: uuid description: Unique identifier for this API request. example: 550e8400-e29b-41d4-a716-446655440000 required: - total - page - per_page - total_pages - request_id ErrorResponse: type: object description: Standard error response envelope. properties: error: type: object properties: type: type: string description: 'Machine-readable error type. The set is OPEN — endpoints define specific types beyond the common ones below, so clients should branch on the types they know and fall back to the HTTP status class for anything unrecognized. Common values: authentication_required, invalid_api_key, wrong_key_type, subscription_inactive, rate_limit_exceeded, validation_error, forbidden, not_found, method_not_allowed (405, carries Allow), conflict, in_use, plan_limit, plan_feature, internal_error, dependency_unavailable (503, carries Retry-After), invalid_request, invalid_definition, not_cancellable, invalid_idempotency_key, idempotency_key_reuse, request_in_progress, system_client_protected, use_oauth, use_dpop_nonce (401 on /v1 and the data plane, 400 on POST /oauth/token; see "DPoP sender-constrained tokens").' example: validation_error message: type: string description: Human-readable error message. example: name and target_base_url are required. request_id: type: string format: uuid description: Unique identifier for this request. example: 550e8400-e29b-41d4-a716-446655440000 required: - type - message - request_id required: - error DeletedResponse: type: object properties: data: type: object properties: deleted: type: boolean example: true required: - deleted meta: $ref: '#/components/schemas/RequestMeta' required: - data - meta ClientFull: description: Full client row as returned by create and update operations. allOf: - $ref: '#/components/schemas/Client' - type: object properties: tenant_id: type: string format: uuid created_by: type: - string - 'null' agent_version: type: - string - 'null' agent_os: type: - string - 'null' agent_arch: type: - string - 'null' agent_hostname: type: - string - 'null' agent_last_seen: type: - string - 'null' format: date-time agent_mode: type: - string - 'null' ClientDetail: description: Extended client object with route assignments. allOf: - $ref: '#/components/schemas/Client' - type: object properties: route_assignments: type: array description: Routes this client is assigned to. items: type: object properties: route_id: type: string format: uuid route_name: type: string example: stripe-payments environment_name: type: string example: production ClientCredential: type: object description: A credential attached to a client. Secret material (HMAC secrets, private keys) is redacted from `data`. properties: id: type: string format: uuid example: 9c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f client_id: type: string format: uuid description: The client this credential belongs to. tenant_id: type: string format: uuid kind: type: string enum: - ip - mtls_thumbprint - signature_hmac - signature_ed25519 - machine_id - workload_identity description: 'The credential kind. Creatable in v1: `ip` and `mtls_thumbprint`.' example: ip label: type: - string - 'null' description: Human-readable label. example: Office egress data: type: object additionalProperties: true description: Kind-specific data. Secret fields (`secret_ct`, `private_key_pem`) are stripped from responses. example: value: 203.0.113.0/24 enabled: type: boolean example: true expires_at: type: - string - 'null' format: date-time description: Expiry timestamp (set automatically for issued mTLS certificates). created_at: type: string format: date-time example: '2025-03-15T10:30:00.000Z' updated_at: type: string format: date-time last_matched_at: type: - string - 'null' format: date-time description: When this credential last matched an incoming request. UpdateClientRequest: type: object description: All fields are optional. Only provided fields will be updated. properties: name: type: string type: type: string enum: - user - server ip_address: type: string description: type: string enabled: type: boolean responses: PlanLimit: description: 'Payment Required. The action exceeds your plan''s limits. Two `error.type` values share this status: `plan_limit` when a COUNTED resource quota was reached (routes, secrets, AI agents, MCP servers), and `plan_feature` when the CAPABILITY itself is not on your tier (custom PII redaction policies, compliance packs, custom prompt-firewall policies). Both mean "upgrade to proceed"; branch on `type` only if you want to distinguish "you have used your allowance" from "buy a bigger plan". Neither ever revokes something you already have: a plan downgrade leaves existing agents, policies and installed packs in place and keeps working. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: plan_limit message: Route limit reached (10). Upgrade your plan to add more. request_id: 550e8400-e29b-41d4-a716-446655440000 NotFound: description: The requested resource was not found. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: not_found message: Route not found. request_id: 550e8400-e29b-41d4-a716-446655440000 InternalError: description: An unexpected server error occurred. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: internal_error message: An unexpected error occurred. request_id: 550e8400-e29b-41d4-a716-446655440000 Unauthorized: description: Authentication is required or the provided API key is invalid. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_key: summary: No API key provided value: error: type: authentication_required message: 'API key is required. Use Authorization: Bearer or x-api-key header.' request_id: 550e8400-e29b-41d4-a716-446655440000 invalid_key: summary: Invalid API key value: error: type: invalid_api_key message: Invalid API key. request_id: 550e8400-e29b-41d4-a716-446655440000 RequestInProgress: description: 'A request with the same idempotency key is still being processed. Retry after a short delay; do not change the request body. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: request_in_progress message: A request with this idempotency key is already in progress. request_id: 550e8400-e29b-41d4-a716-446655440000 IdempotencyKeyReuse: description: 'The supplied idempotency key was already used for a request with a different body. Idempotency keys may only be reused with an identical request. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: idempotency_key_reuse message: This idempotency key was already used with a different request body. request_id: 550e8400-e29b-41d4-a716-446655440000 ValidationError: description: The request failed validation (always `400 validation_error`). A malformed idempotency key returns `400 invalid_idempotency_key`. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validation_error: summary: Request body failed validation value: error: type: validation_error message: name and target_base_url are required. request_id: 550e8400-e29b-41d4-a716-446655440000 invalid_idempotency_key: summary: Malformed idempotency key value: error: type: invalid_idempotency_key message: X-Idempotency-Key must be a non-empty string of at most 255 characters. request_id: 550e8400-e29b-41d4-a716-446655440000 ClientNameConflictOrRequestInProgress: description: "Either of two conflicts, distinguished by `error.type`:\n\n* `conflict` — a client with this name already exists in the caller's own\n data space. Client names are unique per `(tenant, name, Live/Test)`, so\n the same machine MAY be registered under one name in both Live and Test,\n but not twice within one of them. Choose a different name; retrying the\n same one will never succeed.\n* `request_in_progress` — a request with the same idempotency key is still\n being processed. Retry after a short delay; do not change the body.\n" headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: conflict message: A client with this name already exists. request_id: 550e8400-e29b-41d4-a716-446655440000 RateLimited: description: 'Too many requests. Retry after the indicated time. The `X-RateLimit-*` headers are also present on non-429 responses whenever a limit is configured. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: rate_limit_exceeded message: API rate limit exceeded. Please retry later. request_id: 550e8400-e29b-41d4-a716-446655440000 headers: X-RateLimit-Remaining: description: 'Remaining requests in the current window. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 999 KnoxCall-Version: description: 'The dated API version (`YYYY-MM-DD`) that served this response. Equals the value of the `KnoxCall-Version` request header when supplied, otherwise the newest version. ' schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ example: '2026-08-05' X-Request-Id: description: 'Unique identifier for this request (UUID). Present on **every** response and equal to the `request_id` field in the response body. Quote it when contacting support. ' schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 Retry-After: description: Seconds to wait before retrying. Set on `429` responses. schema: type: integer example: 30 X-RateLimit-Reset: description: 'Epoch seconds at which the current rate-limit window resets. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 1735689600 X-RateLimit-Limit: description: 'Maximum requests allowed per window. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 1000 parameters: OrderParam: name: order in: query schema: type: string enum: - asc - desc default: desc description: Sort direction. PageParam: name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number for pagination. Clamped server-side so the derived offset never exceeds 100,000 rows -- the effective maximum is `floor(100000 / per_page) + 1`, i.e. 1,001 at `per_page=100`. A larger value returns that last page, and `meta.page` reports it. PerPageParam: name: per_page in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Number of items per page (max 100). ClientId: name: id in: path required: true schema: type: string format: uuid description: The client UUID. example: b8d2e9f4-3a5c-4d7b-9e0f-2a4c6b8d0e1f IdempotencyKeyParam: name: X-Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: 'Optional idempotency key so a retried mutating request is executed at most once. The standard `Idempotency-Key` spelling is also accepted. Replaying a completed request with the same key returns the original stored response with an `X-Idempotent-Replay: true` header. A key still in progress returns `409 request_in_progress`; the same key with a different body returns `422 idempotency_key_reuse`; a malformed key returns `400 invalid_idempotency_key`. ' example: 3f6c9b2e-1a4d-4c8e-9b0a-7d2e5f1c3a8b securitySchemes: OAuth2: type: oauth2 description: 'OAuth 2.1 authentication — recommended for new integrations. Access tokens (`kc_` prefix) are minted at the root-host token endpoint `https://api.knoxcall.com/oauth/token` and passed as `Authorization: Bearer `. Public clients must use PKCE with the `authorization_code` grant; confidential clients may use `client_credentials`. The first-party SDKs and the `knoxcall login` CLI handle token minting, caching, refresh, and DPoP for you. ' flows: clientCredentials: tokenUrl: https://api.knoxcall.com/oauth/token refreshUrl: https://api.knoxcall.com/oauth/token scopes: routes:read: Read routes. routes:write: Create, update, and delete routes. secrets:read: Read secret metadata. Does NOT include retrieving a live OAuth2 access token. secrets:oauth_token: Retrieve a live upstream OAuth2 access token (GET /v1/secrets/{id}/oauth2/token). Distinct from secrets:read because the call refreshes the credential at the provider. secrets:write: Create, update, and delete secrets. vaults:detokenize: Turn a vault token back into its original value. Required by GET /v1/vaults/{vault}/tokens/{token}, by a token template reference in a /v1/proxy body, and by creating a `detokenize` route action. Distinct from vaults:read, which lists vaults and token metadata and never returns a value. transit:decrypt: Open a portable `kc:` ciphertext with a tenant transit key. Required by creating a `decrypt` route action, which stores a standing instruction to open every matching field on every later request through that route. It is the same capability name the policy engine uses for POST /v1/decrypt. No routes scope satisfies it — managing a route is not permission to open the data flowing through it. proxy:invoke: Call the one-shot ephemeral proxy (any method on /v1/proxy). Required for EVERY verb — the proxy is one capability behind one handler, and a bodyless GET spends an escrowed credential exactly as a POST does. Neither proxy:read nor proxy:write satisfies it. clients:read: Read clients. clients:write: Manage clients. webhooks:write: Manage webhooks. workflows:write: Manage and execute workflows. '*:*': Full access (all scopes). authorizationCode: authorizationUrl: https://api.knoxcall.com/oauth/authorize tokenUrl: https://api.knoxcall.com/oauth/token refreshUrl: https://api.knoxcall.com/oauth/token scopes: routes:read: Read routes. routes:write: Create, update, and delete routes. secrets:read: Read secret metadata. Does NOT include retrieving a live OAuth2 access token. secrets:oauth_token: Retrieve a live upstream OAuth2 access token (GET /v1/secrets/{id}/oauth2/token). Distinct from secrets:read because the call refreshes the credential at the provider. secrets:write: Create, update, and delete secrets. vaults:detokenize: Turn a vault token back into its original value. Required by GET /v1/vaults/{vault}/tokens/{token}, by a token template reference in a /v1/proxy body, and by creating a `detokenize` route action. Distinct from vaults:read, which lists vaults and token metadata and never returns a value. transit:decrypt: Open a portable `kc:` ciphertext with a tenant transit key. Required by creating a `decrypt` route action, which stores a standing instruction to open every matching field on every later request through that route. It is the same capability name the policy engine uses for POST /v1/decrypt. No routes scope satisfies it — managing a route is not permission to open the data flowing through it. proxy:invoke: Call the one-shot ephemeral proxy (any method on /v1/proxy). Required for EVERY verb — the proxy is one capability behind one handler, and a bodyless GET spends an escrowed credential exactly as a POST does. Neither proxy:read nor proxy:write satisfies it. clients:read: Read clients. clients:write: Manage clients. webhooks:write: Manage webhooks. workflows:write: Manage and execute workflows. '*:*': Full access (all scopes). PhantomToken: type: http scheme: bearer description: "The AI **data plane** credential — a `kp_`-prefixed capability token, not a\nManagement API credential. It is minted per agent (or per MCP resource) at\n`POST /v1/ai-gateway/agents/{agentId}/tokens`, or exchanged from a CI workload's\nOIDC token at `POST /v1/oauth/token`, and it is the ONLY credential `/v1/ai/*`\naccepts: an OAuth `kc_` access token or a `tk_` API key is refused there, and a\n`kp_` token is refused on `api.knoxcall.com`.\n\nThree header spellings are accepted, so an existing provider SDK can be pointed at\nthe agent URL without rewriting its auth:\n\n Authorization: Bearer kp_live_a_...\n x-api-key: kp_live_a_...\n x-knox-ai-key: kp_live_a_...\n\n`kp_live_` is refused on the sandbox host and `kp_test_` on the Live host — the env\nsegment is enforced, not cosmetic. DPoP-bound tokens additionally require a valid\n`DPoP` proof header on every request, signed over the canonical public URL rather\nthan a rewritten `Host`.\n\nA rejected credential answers `401`/`403` in the data-plane error envelope with the\ncause in `code` and in the `X-Auth-Failure` response header.\n" BearerAuth: type: http scheme: bearer description: 'Legacy long-lived API key authentication via the Authorization header. Pass your API key as: `Authorization: Bearer tk_xxx_yyy`. Standard keys (`tk_` prefix) are accepted on `api.knoxcall.com`. Test keys (type=test) are accepted on `sandbox.knoxcall.com`. Enterprise Access Keys (`AKE` prefix) are accepted on both. Fully supported, but prefer the `OAuth2` scheme (or the SDKs, which handle OAuth for you) for new integrations. ' ApiKeyAuth: type: apiKey in: header name: x-api-key description: 'Legacy API key authentication via the `x-api-key` header. This is an alternative to Bearer token authentication for clients that cannot set the `Authorization` header. Prefer the `OAuth2` scheme for new integrations. ' CapabilityTokenAuth: type: http scheme: bearer description: 'Single-use client capability token (`kct_` prefix), passed as `Authorization: Bearer kct_...`. Minted server-side via `POST /client-tokens` and bound either to one exact payload + action (`decrypt`, `detokenize`) or to one vault + a closed set of page origins (`tokenize`). This is NOT an API key — it authenticates only the `POST /client/decrypt`, `POST /client/detokenize` and `POST /client/tokenize` consume endpoints and is invalidated after its first use. '