API Reference
Orvanta exposes a REST API that gives you full programmatic access to every feature available in the UI and CLI.
Authentication
Section titled “Authentication”All API requests require a Bearer token. Create a token from the Orvanta UI under User Settings → Tokens, or with the CLI via orvanta user create-token.
Authorization: Bearer <your-token>Base URL
Section titled “Base URL”| Environment | Base URL |
|---|---|
| Orvanta Cloud | https://api.orvanta.cloud |
| Self-hosted | https://<your-instance>/api/v1 |
Versioning
Section titled “Versioning”The current API version is v1. All endpoints are prefixed with /api/v1/.
Breaking changes will be introduced in a new version (e.g. /api/v2/) with a deprecation period for the previous version.
Rate limiting
Section titled “Rate limiting”API requests may be rate limited depending on your edition and instance configuration. When a limit applies, responses include standard rate-limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) and exceeding it returns 429 Too Many Requests. Self-hosted deployments configure limits in platform settings.
Core endpoints
Section titled “Core endpoints”| Resource | Endpoint |
|---|---|
| Workflows | GET /api/v1/workflows |
| Workflow | GET /api/v1/workflows/{id} |
| Runs | GET /api/v1/workflows/{id}/runs |
| Trigger run | POST /api/v1/workflows/{id}/runs |
| Run details | GET /api/v1/runs/{run_id} |
| Run logs | GET /api/v1/runs/{run_id}/logs |
| Consent | POST /api/v1/runs/{run_id}/consent |
| Scripts | GET /api/v1/scripts |
For the full reference with request/response schemas, see the interactive docs: