Plan an API integration.
Base URL
GET /v1/workspace is https://vms.dev/api/v1/workspace.
Authentication
Send the key in theAuthorization header:
x-api-key header. The key sets the workspace of the request, so a request has no workspace parameter.
Scopes
Each endpoint needs one scope. See API key scopes.Pagination
A list endpoint, such asGET /v1/workspace-changes, returns one page:
limit (1 to 100, default 50) to set the page size. To get the next page, send the nextCursor of the last page as cursor. The last page has "nextCursor": null.
Record IDs
Each record ID starts with a prefix that tells its type, such aswsc_ for a workspace change, sbx_ for a sandbox, and op_ for an operation.
Errors
An error response has a code, a message, and the ID of the request:
A sandbox error can have two more fields:
retryAfterSeconds: the time to wait before you try again. TheRetry-Afterheader has the same value.sandboxId: the sandbox that the error is about.
x-request-id header. Give this ID when you ask for help.
The API also serves this reference as an OpenAPI 3.1 document at https://vms.dev/api/v1/openapi.json.