Error codes

Last updated June 29th, 2026

The Knox Asset Intelligence API uses HTTP response 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 due to request inputs, and a 5xx response code indicates a server-side error. Custom error codes provide more detail than the HTTP status alone.

Error object

Most error responses use a JSON body with a top-level result field and a nested error object. Error objects have the following attributes:

Attribute	Type	Description
`result`	String	Outcome of the request. `SUCCESS` for a successful call; `FAIL` when `error` is present.
`error.code`	Integer	The custom error code number.
`error.message`	String	The name of the error code (for example, `RESOURCE_INVALID_PARAM`).
`error.reason`	String	A description of the error, intended to help developers debug the response. This field is optional and may be omitted when no additional detail is available.

Following is an example 400 response:

{
    "result": "FAIL",
    "error": {
        "code": 4000000,
        "message": "RESOURCE_INVALID_PARAM",
        "reason": "pageNum less than 0"
    }
}

Standard HTTP error codes

The following table lists the most common HTTP error responses for the Knox Asset Intelligence API:

HTTP status	Name	Description
200	Success	The request was successful.
400	Bad Request	The client issued an invalid request. Verify your request payload and query parameters (see `error.reason`).
401	Unauthorized	Authorization is required, but the request has not been authenticated.
403	Forbidden	The request was authenticated but does not have permission, or the token is invalid.
404	Not Found	The requested path or resource does not exist.
412	Precondition Failed	A precondition for the request was not met.
415	Unsupported Media Type	The `Content-Type` header is not supported for this endpoint.
429	Too Many Requests	The client exceeded the rate limit (25 requests per second per token or user). Retry after a short delay.
500	Server Error	An error occurred on the server. Retry the request later.

Knox Asset Intelligence error codes

The following table lists custom Knox Asset Intelligence error codes:

`error.code`	`error.message`	Description
2000000	SUCCESS	The request was successful. Used in the Settings API flat response as `code` / `message`.
2000000	FAIL	For partial successes. Used as the `result` value when `error` is populated (not as `error.code`).
4000000	RESOURCE_INVALID_PARAM	The request is invalid. Common causes include invalid JSON, failed validation, invalid pagination (`pageNum`, `pageSize`), or unsupported filter values.
4000001	RESOURCE_NOT_SUPPORTED	The HTTP method is not supported for this path.
4000002	RESOURCE_DUPLICATE_PARAM	The request contains a duplicate parameter or conflicting values.
4010000	AUTHORIZATION_FAIL	The caller is not authorized to use this service or resource.
4030000	AUTHENTICATION_FAIL	Authentication failed or the request is forbidden.
4030001	UNSUPPORTED_MEDIA_TYPE	The request `Content-Type` is not supported. The numeric code uses the 403 prefix; the HTTP response status is 415.
4030002	UNSUPPORTED_FILE_SIZE	The uploaded file or request body exceeds the maximum allowed size. The numeric code uses the 403 prefix; the HTTP response status is 400.
4040000	RESOURCE_NOT_FOUND	The requested resource was not found.
4090000	RESOURCE_CONFLICT	The request conflicts with the current state of the resource.
4120000	PRECONDITION_FAILED_EXCEPTION	A required precondition for the request was not satisfied.
5000000	INTERNAL_SERVER_ERROR	An unexpected server error occurred. Retry the request later.

Troubleshooting

If your request returns a 4xx level error

Read error.code and error.message in the response body (or the authentication code / message if the failure occurred before).
Use error.reason to identify which parameter or rule failed.
Compare your request with the API reference and the validation examples in Error codes.

If your request returns 401 or 403

Regenerate your OAuth 2.0 Authorization token or your legacy x-knox-apitoken. Tokens expire periodically (default expiry is 30 minutes).

If your request returns 429

Reduce your call rate to at most 25 requests per second per API token or user in a tenant. Retry with exponential backoff.

If your request returns a 5xx level error

Retry the request at a later time. If the error persists, contact Samsung Knox support with the HTTP status, error.code, error.message, and error.reason from the response.