Authenticating with the Cloudbox v1 API
The v1 API is read-only: every endpoint accepts GET only and returns 405 for other methods. Call GET /api/v1/me first to confirm your keys work and see which resources they can read.
Your user key comes from Settings > API in Cloudbox and expires, so generate a new one when it does. Both keys must belong to the same organization, the user must be active, and the role needs SETTINGS_API_ACCESS. Each resource also requires its own view permission.
API Endpoint
Current Use Cases
Run this once after Cloudbox Support issues your org key and you generate a user key. A 200 means both keys work and belong to the same organization.
The response lists the resources your role has view access to, so you know which endpoints will work before you build anything.
User keys expire. Ping /me at the start of every scheduled sync and alert your team on a 401 instead of letting the job fail quietly.
Getting 403s on an endpoint? Check /me to confirm the role has SETTINGS_API_ACCESS plus that resource's view permission.
Required Headers
Every request must include the following:
Requests missing either header will return 401 Unauthorized
Example Request
Response Schema
Filters
Errors
Cloudbox uses standard HTTP status codes to indicate API success or failure:
- 200–299 – Request succeeded
- 400 – Bad request (missing parameters, invalid values)
- 401 – Unauthorized (missing or invalid API keys)
- 404 – Resource not found
- 429 – Too many requests (rate limited)