The following status codes are used throughout the API reference.
Error code | Status | Description | Possible fix |
---|---|---|---|
400 | Bad Request | We were unable to understand the request due to the missing parameter or bad syntax. | Please review the request parameters and syntax, and make any necessary corrections before resubmitting the request. |
401 | Unauthorized | The user is not authenticated or does not have permission to access the requested resource. | Please check your bearer token and the manner it is inputed in the request. If the problem persists, please contact our support team for assistance. |
402 | Payment Required | The user's project is currently low on credit. | Please check your project administration as an owner and purchase a sufficient ammount of credits. |
403 | Forbidden | The user is authenticated, but does not have permission to access the requested resource. | Please check if your API key is not restricted to a different IP address or contact our support. |
404 | Not Found | The requested resource could not be found on the server. | Please check the URL and input parameters to ensure that they are correct. |
405 | Method Not Allowed | The requested HTTP method is not allowed for the specified resource. | Please ensure that the HTTP method is correct for the resource being accessed, and that the URL is correct. |
429 | Too Many Requests | The user has exceeded the rate limit for requests. | Please wait a few moments before resubmitting your request, or consider reducing the frequency of your requests to avoid exceeding the rate limit. |
500 | Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. | Please wait a few moments before resubmitting your request, or contact our support team for assistance if the problem persists. |
503 | Service Unavailable | The server is currently unavailable and unable to handle the request. | Please wait a few moments before resubmitting your request, or contact our support team for assistance if the problem persists. |
Error handling
Besides HTTP status codes, which are the main indication if something goes wrong, we also use errors object to report more details about errors.
Errors object example:
{
"errors": [
{
"group": "REQUEST",
"type": "BODY",
"subtype": "EMPTY",
"severity": "critical",
"relatedTo": [],
"description": "Cannot process the request because of the empty body. Please check Foxentry.dev for more information."
},
Errors object atributes:
Name | Description |
---|---|
group | Group that error is categorized in |
type | Type code of error |
subtype | Subtype code of error |
severity | Severity of the error. Info = lowest, warning = moderate, critical = self explanatory |
relatedTo | To what inputs is the error related to. Used mainly for responses with 200 status. |
description | human readable error description. |