Problem types
Every error answer of the API points with type at one of these pages. Each names the cause, the way out and an example answer.
Branch on code in your client. Title and explanation come in the language of your Accept-Language, the code stays the same.
30 problem types
| Status | Code | Title |
|---|---|---|
| 400 | INVALID_REQUEST | Invalid request |
| 400 | BATCH_TOO_LARGE | Batch too large |
| 400 | CURSOR_MISMATCH | Cursor does not match the request |
| 400 | UNKNOWN_PARAMETER | Unknown parameter |
| 401 | UNAUTHENTICATED | Not authenticated |
| 403 | FORBIDDEN | Forbidden |
| 403 | RISK_FAMILY_BLOCKED | Risk family blocked |
| 403 | ORGANIZATION_MISMATCH | Organization mismatch |
| 403 | API_MODULE_DISABLED | Public API not enabled |
| 404 | NOT_FOUND | Not found |
| 404 | OPERATION_NOT_IN_VERSION | Operation not available in this version |
| 409 | IDEMPOTENCY_IN_PROGRESS | Request with this Idempotency-Key still in progress |
| 409 | UPLOAD_INCOMPLETE | Upload incomplete |
| 409 | WEBHOOK_ENDPOINT_LIMIT_REACHED | Too many webhook endpoints |
| 410 | VERSION_SUNSET | API version shut down |
| 412 | PRECONDITION_FAILED | Precondition failed |
| 422 | VALIDATION_FAILED | Validation failed |
| 422 | IDEMPOTENCY_PAYLOAD_MISMATCH | Idempotency-Key used with a different payload |
| 422 | UPLOAD_CHECKSUM_MISMATCH | Upload checksum mismatch |
| 422 | UPLOAD_REJECTED | File rejected |
| 422 | BATCH_FAMILY_NOT_ALLOWED | Family not allowed in a batch |
| 422 | WEBHOOK_URL_INVALID | Invalid webhook URL |
| 428 | PRECONDITION_REQUIRED | Precondition required |
| 429 | RATE_LIMITED | Too many requests |
| 429 | OVERLOADED | Instance overloaded |
| 429 | QUOTA_EXHAUSTED | Quota exhausted |
| 500 | INTERNAL | Internal error |
| 502 | UPSTREAM | Upstream service error |
| 503 | API_PAUSED | API paused |
| 503 | INSTANCE_PENDING | Instance is being updated |