https://orbiter.host/orbiter.pngOfficial documentation for Orbiter Skip to content
Orbiter Docs

Overview

Orbiter API (1.0.0)

Welcome to the Orbiter API! With this API you can deploy and manage your sites on Orbiter programmatically. These docs are still a work in progress so please reach out if you have any issues!

Quickstart

First obtain an API key from app.orbiter.host/api-keys. Click on the New Key button in the top right and select your scope and a name. The permissions for each scope are currently:

  • Member - create site, update site

  • Admin - create site, update site, delete site, manage
    domains, add teammates, remove teammates,
    manage billing

Once you create your key you will only see it once, so copy it somewhere safe! All API request use the following header with your API key:

X-Orbiter-API-Key: <YOUR-ORBITER-API-KEY>

Try using this cURL request with your API key to test it:

curl --location 'https://api.orbiter.host/sites' \
--header 'Content-Type: application/json' \
--header 'X-Orbiter-API-Key: YOUR-API-KEY'

If you already have some sites you should see them in the response!

  • OpenAPI version: 3.0.3

Authentication

X-Orbiter-API-Key

Security scheme type: apiKey

Header parameter name: X-Orbiter-API-Key