API¶
The console, the Terraform provider and the GitHub Actions all use the same GraphQL API.
| Endpoint | https://gateway.cloud.rso.dev/graphql |
| Authentication | Authorization: Bearer <access token> (see Service accounts) |
| Tenant | X-Tenant: <tenant-id> on every request |
| Region | X-Region: BG_CENTRAL_1 (optional) |
curl -s https://gateway.cloud.rso.dev/graphql \
-H "Authorization: Bearer $RSO_DEV_ACCESS_TOKEN" \
-H "X-Tenant: <tenant-id>" \
-H "Content-Type: application/json" \
-d '{"query":"query { quota { resource used limit } }"}'
Conventions¶
- Errors come back in the GraphQL
errorsarray with a machine-readableextensions.code, for exampleAUTHENTICATION_ERROR,NOT_FOUND,QUOTA_EXCEEDED. - Long-running operations (creating an instance) return a task id; poll
taskProgress(taskId)untilCOMPLETEDorFAILED. - Request ids: every response carries
X-Request-Id; send your own to correlate with the audit log. - Limits: query depth 15, 500 selections per operation, 50 operations per batch. Schema introspection is disabled in production.
Every query, mutation and type is listed in the reference, generated from the schema on each gateway release, with the role each operation requires.
A versioned REST API is not available yet; for automation prefer the Terraform provider.