API reference
Every endpoint a Sandscale account can call, by area. Each one lists its permission, parameters, request and response fields and the error codes its handler returns.
New to the API? Start with Using the API, Authentication, Errors and Limits and retries.
Hosts
| Host | What it is |
|---|---|
| https://api.sandscale.dev | The front door. It routes to the region of your request and defaults to the United States. |
| https://api.us.sandscale.dev | The United States, directly. |
| https://api.eu.sandscale.dev | Europe, directly. |
Areas
1366 endpoints in 13 areas.
How this reference is made
A script boots the server's route table, finds the Go function that serves each route open to Sandscale accounts and reads it with the Go type checker: its comment, the type its request body is read into, the types it answers with, the query parameters it reads and the error codes it returns. Vault's engine endpoints come from the vault's own endpoint list. A check in continuous integration fails when this page no longer matches the code.
Some things the reference cannot see: error codes returned deep inside a service are not always listed, and an endpoint whose handler builds its answer without a named type shows no response fields. Where a handler has no comment, the summary is written from its method and path. Endpoints for operating the platform itself are left out.
This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.