Status codes

The API responds with an appropriate HTTP status code and a JSON object. Error responses have a JSON object containing a single message property, which is a human-readable error message.

HTTP status code	Response body
200 OK	Returns a result object
400 Bad Request	{ "message": "[some_field] String should have at most 50 characters" }
401 Unauthorized	{ "message": "A valid secret_key was not found. Did you send it in the Authorization header as a bearer token?" }
403 Forbidden	{ "message": "You've hit the limit on your plan. Please subscribe to a higher plan to continue to use Hitprobe." }
404 Not Found	{ "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again." }
405 Method Not Allowed	{ "message": "The method is not allowed for the requested URL." }
429 Too Many Requests	{ "message": "Too many requests. Please wait before trying again." }
500 Internal Server Error	{ "message": "The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application." }
503 Service Unavailable	{ "message": "The service is temporarily unavailable." }

warning

This list is not exhaustive and we could add others in the future, so be prepared to receive any HTTP status code.

note

The message property returned in an error response is for debugging purposes only and could change at any time, so don't rely on reading it programatically, use the HTTP status code instead.