Troubleshoot

The Knox Guard API uses the conventional HTTP response status codes to indicate the success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates a client-side error, and a 5XX response code indicates a server-side error.

In addition, responses contain a JSON response body with more details about the operation. For example:

• 200 OK
• 200 OK - Async
• 401 Unauthorized

{
    "result" : "SUCCESS",
    "objectId" : "SDAKJ23DKCMSDAKENXSSAEQ",
    "requestedId": "111000291332456"
}

{
    "count" : 3,
    "success": 2,
    "fail": 1,
    "resultList": [
        {
            "result": "FAIL",
            "requestedId": "123456789012347",
            "error" : {
                "code" : "4000000",
                "message" : "RESOURCE_INVALID_PARAM",
                "reason" : "RESOURCE_INVALID_PARAM"
            }
        }
    ]
}

{
    "result" : "FAIL",
    "error" :
    {
        "code": 4010000,
        "message": "AUTHORIZATION_FAIL",
        "reason": "Invalid Api Key"
    }
}

Standard HTTP error codes

The following table lists common HTTP status codes returned by the Knox Guard API:

Error response body

The error response body contains two properties:

The error object

Error responses include an error object, which has the following attributes:

Knox Guard error codes

Knox Guard specifies the following custom error codes which provide more information than the standard HTTP error response codes. The table below lists the standard Knox Guard error codes and their descriptions: