Back to top

Error codes

Last updated October 21st, 2026

Knox Configure APIs use the conventional HTTP response codes to indicate success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates a client-side error due to the request inputs, and a 5XX response code indicates a server-side error. There are also custom error codes specific to the Knox Configure service listed below.

Error object

Each error response contains a JSON body with additional information about the error. The error objects contain the following attributes:

Property Type Description
code String The error code number. If it is unique to Knox Configure, it is a more specific indicator of the error than the HTTP response code.
message String The name of the error code.
data String A description of the error, intended to help developers to debug the error response.

Following is an example 400 response.

{
    "code": 40000000,
    "message": "RESOURCE_INVALID_PARAM",
    "data": "The specified request parameters are not valid."
}

Standard HTTP responses

The following table lists relevant HTTP responses for Knox Configure APIs:

HTTP status Name Description
200 Success The request was successfully received.
201 Created The request was successful and a resource was created.
204 No Content The request was successful but there is no response body to return.
400 Bad Request The client has issued an invalid request. Verify your request (ex. check validation errors in your request payload).
401 Unauthorized Authorization for the API is required, but the request has not been authenticated.
403 Forbidden The request has been authenticated but does not have the appropriate permissions, or the requested resource cannot be found.
404 Not Found The requested path or the specified user does not exist.
429 Too Many Requests Rate limit exceeded. The Knox Configure API has a default rate limit of 10 requests per second per API token or user.
500 Server Error An error has occurred on the server. Please try again later.

Knox Configure error codes

Knox Configure APIs specify custom error codes that provide more information than the standard HTTP response codes. Custom error codes are API version-specific.

Diagnosing common errors

If your request returns a 400 level error

Check the specific error code, update your request parameters or request body accordingly, and retry the request.

If your request returns a 500 level error

Please try the request again at a later time.

Is this page helpful?