Overview API Error Codes
In some cases you will notice status being a non-zero value which means that something has gone wrong while handling
the request. Sometimes the errors are caused by malformed request or authentication, and sometimes it's due to the
validation of the input data.
In this section you can find the error response structure as well as the information about the basic error codes.
{danger.fa-exclamation} IMPORTANT: The basic API error responses will not have the
GT-Authenticationheader, whether it's response to your API request or if it's your 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. |
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"
}
You are currently viewing version 3.4 Latest version here