API reference¶
The NubeStack Cloud API has 237 operations. Each page below lists one service's operations with their parameters, request bodies, responses and schemas, generated from the API's OpenAPI contract.
Read Authentication, Requests and Operations first. Every path starts with /v1.
| Service | Operations | What it covers |
|---|---|---|
| Invitations | 4 | Look up, accept or decline an invitation you were sent. |
| Organizations | 13 | Who you are, your organization, its settings, locations and catalog, and closing it. |
| Instances | 31 | Create, change, act on and delete instances; consoles and console logs. |
| Launch templates | 8 | Saved instance settings, and launching several instances at once. |
| Instance groups | 7 | A number of instances from a template, kept running. |
| Server groups | 2 | Keep instances on different hosts, or together. |
| Images | 3 | The project's own images. |
| Volumes and snapshots | 11 | Block storage volumes and their snapshots. |
| Schedules | 7 | Backup, power and size schedules. |
| Load balancers | 12 | Load balancers, listeners, pools, members and health checks. |
| Certificates | 4 | TLS certificates for HTTPS listeners. |
| Security groups | 5 | Firewall rules for instances and load balancers. |
| Public IPs | 5 | Addresses reachable from the Internet. |
| Networking | 23 | Networks, address ranges, routing, Internet gateways and the network topology. |
| SSH keys | 3 | Public keys copied into new instances. |
| Service accounts and API keys | 14 | Identities for automation, their API keys and cloud credentials. |
| Roles | 12 | Built-in and custom roles, and the actions a role may hold. |
| Members and invitations | 12 | The organization's members, their roles, and invitations. |
| Project access | 5 | Who holds which role on a project. |
| Quota | 13 | Budgets, project quota, presets and requests for more. |
| Usage and costs | 12 | Measured usage, statements, the rate card and the cost explorer. Provisional. |
| Audit log | 3 | Every change, refusal and security event in the organization. |
| Operations | 3 | Follow and cancel the work a change started. |
| Native access | 3 | Connection details, clouds.yaml and console links for each location. |
| Projects | 14 | Projects, their locations, and deleting or resuming them. |
| Resources | 8 | Lists, reads, attachments and activity of any resource type. |