Orbit API
Resource-oriented REST for authoritative DNS, Shield CDN, security rules, hosted RPKI and compute. JSON in, JSON out, one error shape.
Quick start
- Ask for API access via HelpCentre (once per account).
- In the console open API tokens and create a token — choose
readorwritescope and an optional expiry. It is shown once. - Call the API:
curl -H "Authorization: Bearer orb_…" https://dash.yunzheng.space/api/v1/me
curl -X POST https://dash.yunzheng.space/api/v1/dns/zones/42/records \
-H "Authorization: Bearer orb_…" -H "Content-Type: application/json" \
-d '{"name":"www","type":"A","ttl":300,"content":"192.0.2.10"}'
| Base URL | https://dash.yunzheng.space/api/v1 |
|---|---|
| Auth | Authorization: Bearer orb_… · read-only tokens are refused on non-GET calls · expired tokens get 401 |
| Rate limit | 300 requests / minute per token · X-RateLimit-Limit, X-RateLimit-Remaining · 429 rate_limited |
| Errors | {"error":{"code":"…","message":"…"}} — codes: unauthorized forbidden not_found validation_error limit_exceeded conflict upstream_error rate_limited method_not_allowed |
| Versioning | Every response carries X-Orbit-Api-Version: 1. The legacy /api/* RPC used by the console is deprecated for integrations (Deprecation: true). |
| Ownership | You only ever see your own resources; anything else is 404. |
Loading the live specification from dash.yunzheng.space…