The Oxide API is a set of REST APIs that interacts with the Oxide control plane. It follows common HTTP standards such as action verbs and response codes. The response body is in JSON format.
The Oxide API is based on the OpenAPI specification which allows developers to generate API clients and documentation in different programming languages using available OpenAPI tools. This API documentation is generated using the Oxide dropshot Rust program.
Versioning
All API endpoints are at v1 at this time. Although certain API signatures may change between releases (e.g., to support additional request body or URL parameters), they are kept to v1 compatibility currently. You can continue to refer to the latest API documentation when using the v1 API. Any future version bump will be communicated in release notes and highlighted in change logs.
Authentication
Depending on the type of API client you use, you may authenticate to the Oxide rack with session cookies or device tokens. Please refer to the Authentication section for the details about these authentication methods.
Response codes
The Oxide API uses standard HTTP response codes. Read the Responses guide for more details.