Getting started
How an Orbit account is organised, what lives where in the console, and the shortest path from signing in to serving a name from our network.
API reference
API reference.
431 endpoints in 24 products. Pages, SDKs, the CLI and the MCP server are generated from one definition, so they list the same endpoints.
01
Products
| Product | Endpoints | CLI |
|---|---|---|
| Account | 10 | orbit account |
| Organization | 10 | orbit org |
| Services | 15 | orbit services |
| DNS | 30 | orbit dns |
| Shield | 20 | orbit shield |
| Pages | 7 | orbit pages |
| Link | 8 | orbit link |
| Verify | 8 | orbit verify |
| RPKI | 13 | orbit rpki |
| RIPE | 11 | orbit ripe |
| Compute | 4 | orbit compute |
| Webhooks | 8 | orbit webhooks |
| Partners | 9 | orbit partners |
| 48 | orbit mail | |
| Realtime | 9 | orbit realtime |
| Stream | 16 | orbit stream |
| VOD | 17 | orbit vod |
| Talk | 10 | orbit talk |
| Meet | 12 | orbit meet |
| Storage | 7 | orbit storage |
| V-Gate | 94 | orbit vgate |
| Voice | 12 | orbit voice |
| S-Gate | 49 | orbit sgate |
| Billing | 4 | orbit billing |
02
Conventions
- Base URL
https://dash.yunzheng.space/api/v1, token inAuthorization: Bearer orb_…. readendpoints accept a read-only token;writeendpoints need a read + write token.- “Console only” endpoints (tokens, sessions, checkout) accept a signed-in browser session and never a token.
- Body fields marked * are required. Path parameters are positional arguments of the CLI command.
- The machine-readable definition:
GET /api/v1/openapi.json.
Next
Related
DNS hosting
Add a zone, point your registrar at our name servers, manage records: weighted answers, health-checked records, ALIAS at the apex, zone-file import.
Connect a hostname
Delegate the whole domain, delegate one hostname, or add a CNAME and leave your DNS where it is. What each one costs you and when to pick it.