Overview API Error Codes
In some cases, the status field in the response may have a non-zero value, indicating that an error occurred while processing the request.
Errors can result from:
- Malformed or improperly structured requests
- Authentication failures
- Validation issues with the submitted input data
This section explains the structure of error responses and provides details about the standard error codes returned by the API.
{danger.fa-exclamation} IMPORTANT:
Basic API error responses do not include theGt-Authenticationheader — whether they are responses to your API request, or your system's response to invalid or unrecognized input.
Format
✓ - required value
? - optional, value or null
✕ - always appears as null
| Variable | Type | Description | |
|---|---|---|---|
| status | int | ✓ | API communication status - 0 if the request was successful (not relevant for error response) - Negative integer if internal server/network error occurs - Positive integer if application/logical error occurs |
| description | varchar(256) | ✓ | Accurate description of the result |
Status Codes
Below you can find the status-description combinations and extended specification each basic error.
| Status | Description | Meaning and troubleshooting |
|---|---|---|
999 |
Generic Error | This is a generic error without a clear specification. For assistance please contact support. |
400 |
Bad request | Request body is not a valid JSON |
400 |
Timestamp invalid | Timestamp provided within the request is either future or at least 60 seconds old. If you are not sure about possible reasons, please refer to Network Time protocol Wikipedia page for global time synchronization basics. |
400 |
Input validation failed | The input did not pass the validation |
401 |
Account not found | Account not found, disabled or signature doesn't match |
401 |
Website not found | Website not found or disabled |
406 |
Invalid IP | Source (sender) IP address {variable} is not whitelisted for the account |
Example
Invalid IP Error
{
"status": 406,
"description": "Invalid IP"
}