Control-Plane API
Control-Plane API Endpoints
This page lists the control-plane routes that the Verdictan docs describe. Each row links to the page that gives the procedure, the fields, and the limits.
Send each request to the regional API host, for example https://api.eu.verdictan.com. Use a bearer token on organization-scoped routes. The API overview gives the credential rules, the error envelope, and the pagination rules.
For each field and response schema, use the OpenAPI document at GET /v1/openapi.json. To find the permission that a route needs, use the Permissions Reference.
Identity and tokens
| Route | Operation | Details |
|---|---|---|
GET /v1/whoami | Returns the organization, roles, teams, and effective permissions of the credential | verdictan auth |
GET /v1/tokens | Lists governed tokens | Manage API Tokens |
POST /v1/tokens | Creates a governed token. The response shows the secret one time. | Manage API Tokens |
DELETE /v1/tokens/{id} | Revokes a governed token | Manage API Tokens |
POST /v1/tokens/exchange-code | Changes a PKCE authorization code into one minimum-privilege API token | verdictan auth |
OAuth
| Route | Operation | Details |
|---|---|---|
POST /v1/oauth/token | Exchanges an authorization code or a refresh token for an access token | OAuth Clients |
POST /v1/oauth/revoke | Revokes an access token or a refresh token | OAuth Clients |
The browser starts authorization at the Console /oauth/authorize route. The API route GET /v1/oauth/authorize is retired.
Agents and gateways
| Route | Operation | Details |
|---|---|---|
GET /v1/agents | Lists the agents that the credential can access, with cursor pagination | API overview |
POST /v1/agents/{id}/provider-key-access/bindings | Attaches a role to the provider key access of an agent | Connect Your Model Provider |
POST /v1/agents/{id}/provider-key-access/simulations | Evaluates provider key authorization for an agent | Connect Your Model Provider |
DELETE /v1/agents/{id}/provider-key-access/bindings/{role_id} | Removes a role from the provider key access of an agent | Connect Your Model Provider |
GET /v1/gateways | Lists the gateways that the control plane knows | verdictan gateway |
POST /v1/gateways/{id}/machine-token | Rotates the machine token of a connected gateway | Manage Gateways |
Configuration templates
| Route | Operation | Details |
|---|---|---|
GET /v1/templates | Lists configuration templates | verdictan init |
GET /v1/templates/{id} | Returns one template with its starter configuration | verdictan init |
Events and evidence
| Route | Operation | Details |
|---|---|---|
GET /v1/events | Queries governance events. The since parameter is necessary. | verdictan events |
GET /v1/exports/jobs/{job_id}/manifest | Returns the evidence manifest of a completed export job | Export Evidence for a Review |
AI usage streaming
| Route | Operation | Details |
|---|---|---|
GET /v1/ai-usage-stream/delivery-health | Returns the delivery health of each destination | AI Usage SIEM Streaming |
GET /v1/ai-usage-stream/destinations/{id}/delivery-status | Returns the most recent delivery attempts of one destination | AI Usage SIEM Streaming |
Context Fabric
| Route | Operation | Details |
|---|---|---|
POST /v1/context/register | Registers or updates the session of the authenticated user | Context Fabric Lifecycle |
POST /v1/context/share | Shares a context document | Context Fabric Lifecycle |
POST /v1/context/search | Searches the authorized context scope | Context Fabric Lifecycle |
GET /v1/context/recent | Lists recent context for a bounded scope | Context Fabric Lifecycle |
POST /v1/context/verification/apply | Applies verification outcomes to documents in scope | Context Fabric Lifecycle |
POST /v1/work-receipts | Records a work receipt | Context Fabric Lifecycle |
POST /v1/work-receipts/search | Finds work receipts in scope | Context Fabric Lifecycle |
POST /v1/context-flush | Condenses session context into a recall document | Context Fabric Lifecycle |
DELETE /v1/context/by-user/{id} | Starts the destructive purge of the context of one user | Context Fabric Lifecycle |
The lifecycle page lists the other context search, graph, and correction routes.
Discovery and health
| Route | Operation | Details |
|---|---|---|
GET /v1/openapi.json | Returns the OpenAPI 3.1 document of the active API | API overview |
GET /v1/health | Returns the liveness state of the versioned API | verdictan doctor |
GET /healthz | Returns the liveness state of the API process | API overview |
GET /readyz | Returns the readiness state of the API dependencies | API overview |
Limits
- This page is not a complete list of the routes in the OpenAPI document. A route in the OpenAPI document does not show that the route is available to your organization or your role.
- Routes with the
/v1/gateway/prefix use machine runtime tokens. Do not call them from a customer application. - Do not infer a route from a Console URL or a generated client name.
Next steps
- Verdictan API Overview: authenticate a request and read the error envelope.
- OAuth Clients: get delegated access for a third-party application.
- Permissions Reference: find the IAM action for each operation.
- Manage API Tokens: create and rotate API tokens.