Error Codes
We use bitmasking for our error codes, below is an overview on what we print.
Global Error codes
Global error codes indicate that they can appear on ALL interfaces and methods. You should check for these on all occasions
However non-Global error codes indicate that each respective code is used in a specific interface or method. More info about this is listed on each API page.
SERVER ERROR codes should not be listened on, we use a 500 status code respectively. They are displayed here for debugging purposes.
RED keys indicate an error
YELLOW keys indicate a warning
GREEN keys indicate a successful response
GREY keys indicate an error code only used in the legacy API or newest interfaces
Error Text | Hex | Explanation | Global | Used In | Labels |
|---|---|---|---|---|---|
NONE | 0x0 | Everything is fine | YES | GLOBAL | |
INVALID_SERVICE | 0x1 | The service you requested does not exist | NO | ||
INTERFACE_NOT_FOUND | 0x2 | The API Interface you targeted does not exist | YES | GLOBAL | |
GENERATE_FAILED | 0x4 | Generation of a Badge failed | NO | ||
INVALID_PLUGIN_NAME | 0x8 | Server Error, Plugin name does not conform naming scheme | YES | GLOBAL | SERVER ERROR |
QUERY_FAILED | 0x10 | Your query failed or returned no results | NO | ||
METHOD_DEPRECATED | 0x20 | The method you are targeting is deprecated | YES | GLOBAL | |
INTERFACE_DEPRECATED | 0x40 | The interface you are targeting is deprecated | YES | GLOBAL | |
VERSION_DEPRECATED | 0x80 | The version you are targeting is deprecated | YES | GLOBAL | |
REQUEST_SUCCESS | 0x100 | Used in new versions: The request has been successfully processed. Use this instead of NONE/0x0. | YES | GLOBAL | |
VERSION_NOT_FOUND | 0x200 | The version you requested does not exist | YES | GLOBAL | |
INVALID_CASE | 0x400 | The case you requested does not exist | NO | ||
INVALID_TOPIC | 0x800 | The topic you requested does not exist | NO | ||
INVALID_POINT | 0x1000 | The point you requested does not exist | NO | ||
METHOD_NOT_ALLOWED | 0x2000 | This error code is sent along with HTTP 405 | YES | GLOBAL | |
NOT_IMPLEMENTED | 0x4000 | This error code is sent along with HTTP 501 | YES | GLOBAL | |
MISSING_PARAMETER | 0x8000 | A parameter is missing in your request | YES | GLOBAL | |
INVALID_PARAMETER | 0x10000 | A parameter you supplied is not valid | YES | GLOBAL | |
GENERIC_ERROR | 0x20000 | For when we do not have an error message | YES | GLOBAL | |
SERVICE_DUPLICATE | 0x40000 | The service already exists | NO | ||
INVALID_SUBNET | 0x80000 | The request requires a whitelisted subnet. | YES | GLOBAL | |
POSTGRES_CONN_ERROR | 0x100000 | The connection to the database failed | YES | GLOBAL | SERVER ERROR |
POSTGRES_QUERY_MALFORMED | 0x200000 | A postgres SQL query is malformed | YES | GLOBAL | SERVER ERROR |
ELASTIC_CONN_ERROR | 0x400000 | The connection to elastic search failed | YES | GLOBAL | SERVER ERROR |
ELASTIC_QUERY_MALFORMED | 0x800000 | Your search query was malformed | NO | ||
REDIS_CONN_ERROR | 0x1000000 | The connection to redis failed | YES | GLOBAL | SERVER ERROR |
REDIS_QUERY_MALFORMED | 0x2000000 | The query to the redis server was malformed | YES | GLOBAL | SERVER ERROR |
TWIG_ERROR | 0x4000000 | An error occurred rendering a template | YES | GLOBAL | SERVER ERROR |
PLUGIN_MISSING_INCLUDES | 0x8000000 | A plugin could not be loaded due to a missing include file | YES | GLOBAL | SERVER ERROR |
THEME_MISSING_INCLUDES | 0x10000000 | A theme component could not be loaded due to a missing include file | YES | GLOBAL | SERVER ERROR |