Secure access
Planetary Orbit APIs rely on API keys scoped to a workspace. Keys belong to a human user and inherit their role permissions.Key lifecycle
- Open Workspace → Settings → Public API.
- Click Create key, give it a descriptive name (e.g.,
integration-gateway). - Copy the key once—you won’t see it again. Store it in your secrets manager (GitHub Secrets, AWS Secrets Manager, etc.).
- Rotate regularly: create a replacement key, update your deployments, then delete the old one.
Keep one key per integration. This makes audits easier and lets you revoke access without disrupting unrelated systems.
Calling the API
All requests must include theAuthorization header with a bearer token.
Multi-factor authentication (MFA)
Admins should enable MFA via Workspace → Security to protect the key creation flow and prevent unauthorized API key leakage.Troubleshooting
- 401 Unauthorized? Verify the header is spelled
Authorization(capital A) and the key starts withorbit_. - 429 Too Many Requests? Back off for one minute or cache results—quota resets every 60 seconds per key.