Using the Stax API
The Stax API provides programmatic access to Stax functionality. It is an OpenAPI-based REST API that uses resource-orientated URLs, JSON for return responses, and HTTP for response codes and user authentication.
tip
For those new to the Stax API, consider starting with the Python SDK. It handles authentication and provides wrappers with error handling for API endpoints.
Accessing the API
There is a unique API for each Stax Installation Region:
| Stax Installation | OpenAPI Specification | Documentation |
|---|---|---|
| stax-au1 | https://api.au1.staxapp.cloud/20190206/public/api-document | Documentation |
| --- | --- | --- |
| stax-eu1 | https://api.eu1.staxapp.cloud/20190206/public/api-document | Documentation |
| --- | --- | --- |
| stax-us1 | https://api.us1.staxapp.cloud/20190206/public/api-document | Documentation |
| --- | --- | --- |
API Coverage
Not all modules of Stax are API-capable. Review the list below to understand which services can be addressed using the API:
| Module | API Support |
|---|---|
| Accounts | ✔️ |
| Organizational Units | ✔️ |
| Policies | ✔️ |
| Service Configuration | ✔️ |
| Networks | ✔️ |
| Workloads | ✔️ |
| Identity | ✔️ |
| Cost | ❌ |
| Rules | ❌ |
| Data | ❌ |
| Views | ❌ |