Base URL
All API requests are made over HTTPS to the following base URL:Versioning
The current API version isv1, reflected in the base URL path. When Varo Cloud introduces changes that would break existing integrations — such as removing a field, changing a field’s type, or altering existing behavior — a new version prefix (e.g., /v2) will be released and the previous version will continue to work during a deprecation window.
Non-breaking additions, including new optional fields on existing responses, new query parameters, and entirely new endpoints, are rolled out without a version bump. You should write your integration to ignore unknown fields so these additions do not affect your code.
Request Format
All request bodies must be sent as JSON. Include theContent-Type: application/json header on every request that has a body, such as POST, PUT, and PATCH requests. All responses from the API are also JSON.
Response Format
Successful responses are wrapped in a standard envelope. A single-resource response looks like this:pagination object alongside data:
meta.request_id field is present on every response. Include it when contacting support so issues can be traced quickly.
Pagination
List endpoints use cursor-based pagination. Rather than requesting results by page number, you pass thenext_cursor value returned in the previous response as the cursor query parameter of your next request. This approach stays consistent even when records are added or removed between requests.
Use the per_page parameter to control how many items are returned per page (maximum 100). If next_cursor is absent from the response, you have reached the last page.
Rate Limits
The default rate limit is 1,000 requests per 10-minute window per API key. If you need a higher limit for production workloads, contact Varo Cloud support to discuss an increased quota.
| Header | Description |
|---|---|
X-RateLimit-Limit | Total requests allowed in the current window |
X-RateLimit-Remaining | Requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the current window resets |
429 Too Many Requests response. Wait until the X-RateLimit-Reset time before retrying. See the Errors page for retry guidance.
Available Resources
Projects
Create, configure, and delete projects. Manage project-level settings and environment variables.
Deployments
Trigger and monitor deployments, roll back to previous versions, and inspect deployment logs.
Users
Invite team members, update roles, and remove users from your organization.
Integrations
Connect third-party services and manage credentials for your integrated tools.
Webhooks
Register and manage webhook endpoints to receive real-time event notifications.
