REST API

Zorven REST API

Manage tunnels, clients, domains and IP rules programmatically, and read request logs and usage data. The OpenAPI 3.1 reference is below.

  1. Create a tokenOpen the API Keys section of the dashboard.
  2. Pick scopes and lifetimeChoose the scopes you need (for example tunnels:read) and an expiry. A token is shown only once.
  3. Send the requestAdd the token to every request in the Authorization: Bearer header.
$curl -H "Authorization: Bearer zrv_api_..." https://zorven.app/api/v1/tunnels

MCP and OAuth 2.1: the same API is also reachable at https://zorven.app/mcp (OAuth 2.1 + PKCE S256, dynamic client registration). The OAuth full scope gives an MCP client the same authority as your dashboard session (never more than your own). It is off by default on the consent screen and needs a fresh sign-in within 5 minutes (step-up); access tokens last 30 minutes, every call is audit-logged, and a few endpoints such as API tokens and service accounts stay excluded. See "OAuth 2.1 and MCP" in the reference below.

API access is available on Pro and above. Programmatic requests are limited to about 30 requests/sec per tenant. Compare plans or see the CLI docs.