Skip to main content

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​

RouteOperationDetails
GET /v1/whoamiReturns the organization, roles, teams, and effective permissions of the credentialverdictan auth
GET /v1/tokensLists governed tokensManage API Tokens
POST /v1/tokensCreates a governed token. The response shows the secret one time.Manage API Tokens
DELETE /v1/tokens/{id}Revokes a governed tokenManage API Tokens
POST /v1/tokens/exchange-codeChanges a PKCE authorization code into one minimum-privilege API tokenverdictan auth

OAuth​

RouteOperationDetails
POST /v1/oauth/tokenExchanges an authorization code or a refresh token for an access tokenOAuth Clients
POST /v1/oauth/revokeRevokes an access token or a refresh tokenOAuth Clients

The browser starts authorization at the Console /oauth/authorize route. The API route GET /v1/oauth/authorize is retired.

Agents and gateways​

RouteOperationDetails
GET /v1/agentsLists the agents that the credential can access, with cursor paginationAPI overview
POST /v1/agents/{id}/provider-key-access/bindingsAttaches a role to the provider key access of an agentConnect Your Model Provider
POST /v1/agents/{id}/provider-key-access/simulationsEvaluates provider key authorization for an agentConnect Your Model Provider
DELETE /v1/agents/{id}/provider-key-access/bindings/{role_id}Removes a role from the provider key access of an agentConnect Your Model Provider
GET /v1/gatewaysLists the gateways that the control plane knowsverdictan gateway
POST /v1/gateways/{id}/machine-tokenRotates the machine token of a connected gatewayManage Gateways

Configuration templates​

RouteOperationDetails
GET /v1/templatesLists configuration templatesverdictan init
GET /v1/templates/{id}Returns one template with its starter configurationverdictan init

Events and evidence​

RouteOperationDetails
GET /v1/eventsQueries governance events. The since parameter is necessary.verdictan events
GET /v1/exports/jobs/{job_id}/manifestReturns the evidence manifest of a completed export jobExport Evidence for a Review

AI usage streaming​

RouteOperationDetails
GET /v1/ai-usage-stream/delivery-healthReturns the delivery health of each destinationAI Usage SIEM Streaming
GET /v1/ai-usage-stream/destinations/{id}/delivery-statusReturns the most recent delivery attempts of one destinationAI Usage SIEM Streaming

Context Fabric​

RouteOperationDetails
POST /v1/context/registerRegisters or updates the session of the authenticated userContext Fabric Lifecycle
POST /v1/context/shareShares a context documentContext Fabric Lifecycle
POST /v1/context/searchSearches the authorized context scopeContext Fabric Lifecycle
GET /v1/context/recentLists recent context for a bounded scopeContext Fabric Lifecycle
POST /v1/context/verification/applyApplies verification outcomes to documents in scopeContext Fabric Lifecycle
POST /v1/work-receiptsRecords a work receiptContext Fabric Lifecycle
POST /v1/work-receipts/searchFinds work receipts in scopeContext Fabric Lifecycle
POST /v1/context-flushCondenses session context into a recall documentContext Fabric Lifecycle
DELETE /v1/context/by-user/{id}Starts the destructive purge of the context of one userContext Fabric Lifecycle

The lifecycle page lists the other context search, graph, and correction routes.

Discovery and health​

RouteOperationDetails
GET /v1/openapi.jsonReturns the OpenAPI 3.1 document of the active APIAPI overview
GET /v1/healthReturns the liveness state of the versioned APIverdictan doctor
GET /healthzReturns the liveness state of the API processAPI overview
GET /readyzReturns the readiness state of the API dependenciesAPI 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​