API Overview

REST API for managing tunnels, domains, and keys.

Base URL

code

https://api.deployzy.com/api/v1

Authentication

All protected endpoints require one of:

code

Authorization: Bearer <jwt_token>

code

X-API-Key: sm_live_...

API keys carry a scope — read, deploy, or full. A deploy key can create and deploy projects but can't manage keys, billing, or delete your account (ideal for CI). See API Keys. JWT sessions are always full access.

What you can manage

Tunnels · Projects & deploys (from a git repo, a prebuilt image, or an uploaded directory) · databases · custom domains · API keys · request inspection.

Response format

All responses are JSON. Errors return:

json

{ "error": "description of what went wrong" }

Rate limits

Plan	Limit
Free	100 req/s
Pro	500 req/s
Team	2000 req/s

When rate limited, you'll receive a 429 status with a Retry-After header.