Errors
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
Every error answers a JSON body with a stable, machine-readable code and a message for people, such as { "code": "api-key-missing-scope", "message": "This API key does not have the scope this endpoint requires" }.
| Status | Means |
|---|---|
| 400 | The request is invalid. data-validation-error says which fields failed and why |
| 401 | The key is missing, unknown, revoked (api-key-invalid) or expired (api-key-expired), or its user left the organization (api-key-organization-left). The WWW-Authenticate header says where to sign in with OAuth |
| 403 | The key lacks the endpoint's scope (api-key-missing-scope, with the scope in the WWW-Authenticate header), or the user isn't an owner or admin (require-admin-permission) |
| 404 | The resource or path doesn't exist |
| 429 | Too many requests (rate-limit-exceeded): wait the seconds in the Retry-After header |
| 5xx | Something failed on our side: retry later |