Docs

Documentation.

Written for somebody with an account and a problem. Every page is the shortest path from where you are to the thing working.

All documentation

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.

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.

Link (origin tunnels)

A connector on your server dials out to a city you choose and holds the connection open; your site is reachable through Orbit with no public address or port.

Use our public DNS

Step-by-step settings for Windows, macOS, iOS, Android, Linux and routers, for the unfiltered, filtered and DNS64 resolvers, over plain and encrypted DNS.

RPKI

Point your routers at our free public RPKI-to-Router cache, or let us host the CA that signs your own address space and publish it from every anycast node.

Verify

A widget most visitors never click, one server-side confirmation request, no cookies, iframes or cross-site tracking. Drop-in HTML and the siteverify contract.

Using the API

How to get a token, what the responses look like, which errors mean what, and how listing endpoints page. Everything the console does is available here.

CLI and AI agents

Use Orbit from a terminal, from a config file kept with your code, or from an AI agent: a command per API endpoint, plan and apply, and a remote MCP server.

Shield: cache, rules, TLS

What the edge caches and for how long, what the managed WAF inspects, how rate limiting and network rules interact, and how certificates issue and renew.

Pages (static sites)

Upload a folder, point one of your hostnames at it, and return to an earlier deploy without re-uploading. Two tiers, what each serves, and the file conventions.

Realtime (rooms)

Create a voice or video room, hand out its link, or render it inside your own page with the client library. What a room can require before it admits anyone.

Stream (live)

Create a channel, paste its RTMPS server and key into your broadcasting software, and hand out the watch address. What caching, renditions and a lost key mean.

Talk (chat)

Create a conversation, hand out its link or mint entry tokens from your backend, and embed the SDK. Messages arrive in order; a dropped connection resumes.

VOD (on demand)

Create a video, send the file in parts, and hand out the playback address. What the ladder is, what a private video needs, and what is counted.

Meet (embed)

Put a whole meeting inside your own page with one script tag and one call: the options, the events, error handling, and the permissions the frame needs.

API reference

The complete Orbit API, product by product: all 523 endpoints with scope, parameters, CLI command and MCP tool, generated from the API definition.

SDK source

The Realtime, Talk, Meet, Verify and player SDKs, with API examples, are published in the orbit-sdks repository on GitHub, byte for byte what the platform serves.