The Ocrolus API leverages a specific set of HTTP Status Codes to indicate the success or failure of an incoming request.

All requests that are successfully routed to our API will return the HTTP Status Code of 200 OK.

Any requests that are obstructed by server issues can be diagnosed with these HTTP Status Codes (these are rare):

HTTP Status Code

Cause

502 Bad Gateway

The Ocrolus public proxy is experiencing issues

503 Service Unavailable

The service has been taken down for maintenance

504 Gateway Timeout

The service did not respond within a reasonable time

429 Too Many Requests

The user is being rate-limited by the Ocrolus proxy gateway

📘

Application error codes

If an application error is generated when processing the request, the error is reported in the JSON response as described in the Ocrolus Status Codes section below.