Error codes

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 401 response.

HTTP/1.1 401 Unauthorized

Content-Type: application/json

{
    "code": 4012250,
    "message": "ACCESS_TOKEN_BAD_REQUEST",
    "data": "ACCESS_TOKEN_BAD_REQUEST"
}

Async result: PUT kcs/v1/kc/devices/assign

Standard HTTP error codes

The following table lists the most common HTTP error responses:

Code	Name	Description
200	Success	The request was successfully received.
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.
409	Conflict	The request could not be completed due to a conflict with the current state of the target resource.
500	Server Error	An error has occurred on the server. Please try again later.

Knox Configure error codes

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

Code	Message	Description
40000000	RESOURCE_INVALID_PARAM	The specified request parameters are not valid.
40000017	PROFILE_ID_MISSING	There is no provided `profileId`, or `profileName` provided has no ID in your request to the Assign Knox Configure Profile API. Please check the fields in your request and try resending.
4012250	ACCESS_TOKEN_BAD_REQUEST	The request for an access token is invalid. Please check the fields in your request.
40300000	AUTHORIZATION_FAIL	The current user is unauthorized to use this service.
40400000	RESOURCE_NOT_FOUND	The specified resource is not found.
40400005	DEVICES_NOT_FOUND	The devices are not found in your request to the Assign Knox Configure Profile API. Please check the fields in your request and try resending.
40400007	LICENSE_NOT_FOUND	The license to be used for profile assignment is not found in your request to the Assign Knox Configure Profile API. Please check the fields in your request and try resending.
50000000	INTERNAL_SERVER_ERROR	An unknown internal server error has occurred.

Troubleshooting

If your request returns a 400 level error

Check the specific error code and refer to the error codes section of this reference.

If your request returns a 500 level error

Please try the request again at a later time.