Bifrost API
Reference for Bifrost's public HTTP/REST API: operations, request and response schemas, authentication, and errors.
The API is served from https://api.bifrost.carrier.io. Documented paths are
relative to that host.
This API is still being built. Commands, OTA updates, and configuration will be available soon. See the roadmap.
Errors
Most error responses use { "message": string, "details"?: object }.
403 and 429 use a different shape; both are documented on each operation.
Authentication
- API Key: AwsSigV4
AWS IAM Signature Version 4 on the Authorization header. Each request uses a new signature, not a stored API key. Sign with region eu-west-1 and service execute-api. See Authenticating in the Bifrost Handbook for AssumeRole, tier roles, and examples.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |