Skip to main content
Every public endpoint is listed in the sidebar, grouped by area. Each page shows the parameters, request body, responses and, for endpoints that accept API tokens, the scope you need. You can call any of them from the playground with your own token.

​
Base URL

Operation paths in the reference start at /v1, so GET /v1/cloud is https://my.server.express/api/v1/cloud.

​
Authentication

Send a bearer credential on every authenticated request:
The spec defines two security schemes: If you’re writing a script, use apiToken. An operation without x-required-scope needs a session, and a token sent to it gets a 401. Authentication has the full scope list.

​
Response envelope

Every JSON response uses the same shape:
The reference shows the data shape for each operation. Errors share one ErrorResponse schema. Read the status code to decide what to do, and treat error as a message for a person. Errors and rate limits covers every status and the IP-blocking rules.

​
Where this comes from

These pages are generated from openapi/public.yaml in the Server.Express repo, the OpenAPI description of the customer-facing API. When an endpoint changes, the spec changes with it, so the reference stays in step with the server rather than with someone’s memory. If something here disagrees with what the API actually does, the API is right and the spec is a bug. Tell us and we’ll fix it.