API Reference

import { LinkCard } from ‘@astrojs/starlight/components’;

Orvanta exposes a REST API that gives you full programmatic access to every feature available in the UI and CLI.

Note

The interactive API reference (Swagger/OpenAPI) is served directly from your Orvanta instance at /docs. For Orvanta Cloud, visit:

https://api.orvanta.cloud/docs

Authentication

All API requests require a Bearer token. Generate tokens from the Orvanta dashboard under Settings → API tokens.

Authorization: Bearer orvanta_pat_xxxxxxxxxxxx

Base URL

Environment	Base URL
Orvanta Cloud	https://api.orvanta.cloud
Self-hosted	https://<your-instance>/api/v1

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

Plan	Requests per minute
Free	60
Pro	600
Enterprise	Unlimited (fair use)

Rate limit headers are included on all responses:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 598
X-RateLimit-Reset: 1710000060

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: