Error codes
Last updated May 26th, 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.
Knox Configure v2 error codes
The following table describes custom error codes for the Knox Configure v2 API:
code |
message |
data |
|---|---|---|
| 40000000 | RESOURCE_INVALID_PARAM | The specified request parameters are not valid. |
| 40000017 | PROFILE_ID_MISSING | Profile ID is required. |
| 40000025 | PROFILE_NAME_MISSING | Profile name is missing. |
| 40000026 | PHONE_NUMBER_MISSING | Phone number is missing. |
| 40000027 | PHONE_NUMBER_INVALID | Phone number should be at least 7 characters and doesn’t have any special characters, except ‘+’. |
| 40000028 | EULA_TITLE_MISSING | Eula title is required. |
| 40000029 | EULA_TERMS_AND_CONDITION_MISSING | Eula terms and condition is required. |
| 40000030 | EULA_TYPE_MISSING | Eula type is required. |
| 40000031 | CUSTOMER_SUPPORT_OBJECT_MISSING | Customer support object is required due to supportEmailAddress and supportPhoneNumber fields. |
| 40000032 | CUSTOMER_SUPPORT_EMAIL_MISSING | Support email is missing. |
| 40000033 | EMAIL_FORMAT_INVALID | Email format is invalid. |
| 40000034 | EMAIL_DOMAIN_NOT_SUPPORTED | Email domain not supported. |
| 40000035 | RESOLUTION_MISSING | Resolution cannot be null if folderConfig is not null. |
| 40000036 | RESOLUTION_COLUMN_COUNT_INVALID | Resolution column count can only range between 4-5. |
| 40000037 | RESOLUTION_ROW_COUNT_INVALID | Resolution row count can only range between 4-6. |
| 40000038 | RESOLUTION_PAGE_COUNT_INVALID | Resolution page count can only range between 1-8. |
| 40000039 | FOLDER_NAME_MISSING | Folder name is missing. |
| 40000040 | FOLDER_X_COORDINATE_INVALID | X coordinate for google play folder should be only between 1 and what is specified in the resolution object. |
| 40000041 | FOLDER_Y_COORDINATE_INVALID | Y coordinate for google play folder should be only between 1 and what is specified in the resolution object. |
| 40000042 | FOLDER_PAGE_INVALID | Folder page index should be only between 0 and what is specified in the resolution object. |
| 40000044 | LICENSE_EXPIRED | Cannot use license as it is already expired. |
| 40000045 | NO_LICENSE_SEATS_AVAILABLE | Cannot use license as it has no license seats available. |
| 40000046 | PROFILE_LICENSE_TYPE_MISMATCH | Cannot use license as it is incompatible with the profile. |
| 40000047 | WELCOME_SCREEN_IMAGE_INVALID | The image does not exist. |
| 40000048 | COLOR_INVALID_FORMAT | The hex color provided is in invalid format. |
| 40000052 | INVALID_PROFILE_APP | Selected app is not valid for Profile. |
| 40000054 | REQUEST_BODY_MISSING | The request body cannot be null. |
| 40000055 | PROFILE_TYPE_INVALID | The profile type is invalid. |
| 40000056 | DEVICE_PRODUCT_TYPE_INVALID | The device product type is invalid. |
| 40000057 | DEVICE_LEVEL_INVALID | The device level is invalid. |
| 40000058 | GET_PROFILES_SORT_BY_INVALID | Sorting is only allowed on fields updateTime and name. |
| 40000059 | SORT_ORDER_INVALID | Sort order is invalid. |
| 40000060 | LICENSE_KEY_MISSING | The license key is required. |
| 40000061 | PROFILE_PUSH_TYPE_INVALID | The profile push type is invalid. |
| 40000062 | LICENSE_INVALID | The license is invalid. |
| 40000063 | LICENSE_NAME_MISSING | The license name is required. |
| 40000065 | LICENSE_TYPE_INVALID | The license type is invalid. |
| 40000066 | LICENSE_STATUS_INVALID | The license status is invalid. |
| 40000067 | LICENSE_INVALID_SORT_BY | Sort by is invalid. |
| 40100000 | AUTHORIZATION_FAIL | The current user is unauthorized to use this service. |
| 40400005 | DEVICES_NOT_FOUND | List of IMEI/Serial numbers is required. |
| 40400012 | KC_LICENSE_NOT_FOUND | The license doesn’t exists. |
| 50000000 | INTERNAL_SERVER_ERROR | An unknown internal server error has occurred. |
Knox Configure v1 error codes
The following table describes custom error codes for the Knox Configure v1 API:
code |
message |
data |
|---|---|---|
| 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. |
| 40000020 | USER_MISSING | USER_MISSING |
| 40000021 | TENANT_MISSING | TENANT_MISSING |
| 40000021 | PACKAGE_VERSION_MISSING | Package Version is missing. |
| 40000022 | PACKAGE_NAME_MISSING | Package Name is missing. |
| 40000022 | PACKAGE_VERSION_INVALID | Package Version is invalid. |
| 40000024 | PLAY_STORE_URL_MISSING | Play Store URL is missing. |
| 40000025 | PROFILE_NAME_MISSING | Profile name is missing. |
| 40000026 | PHONE_NUMBER_MISSING | Phone number is missing. |
| 40000027 | PHONE_NUMBER_INVALID | Phone number should be at least 7 characters and doesn’t have any special characters, except ‘+’. |
| 40000028 | EULA_TITLE_MISSING | Eula title is required. |
| 40000029 | EULA_TERMS_AND_CONDITION_MISSING | Eula terms and condition is required. |
| 40000030 | EULA_TYPE_MISSING | Eula type is required. |
| 40000031 | CUSTOMER_SUPPORT_OBJECT_MISSING | Customer support object is required due to supportEmailAddress and supportPhoneNumber fields. |
| 40000032 | CUSTOMER_SUPPORT_EMAIL_MISSING | Support email is missing. |
| 40000033 | EMAIL_FORMAT_INVALID | Email format is invalid. |
| 40000034 | EMAIL_DOMAIN_NOT_SUPPORTED | Email domain not supported. |
| 40000035 | RESOLUTION_MISSING | Resolution cannot be null if folderConfig is not null. |
| 40000036 | RESOLUTION_COLUMN_COUNT_INVALID | Resolution column count can only range between 4-5. |
| 40000037 | RESOLUTION_ROW_COUNT_INVALID | Resolution row count can only range between 4-6. |
| 40000038 | RESOLUTION_PAGE_COUNT_INVALID | Resolution page count can only range between 1-8. |
| 40000039 | FOLDER_NAME_MISSING | Folder name is missing. |
| 40000040 | FOLDER_X_COORDINATE_INVALID | X coordinate for google play folder should be only between 1 and what is specified in the resolution object. |
| 40000041 | FOLDER_Y_COORDINATE_INVALID | Y coordinate for google play folder should be only between 1 and what is specified in the resolution object. |
| 40000042 | FOLDER_PAGE_INVALID | Folder page index should be only between 0 and what is specified in the resolution object. |
| 40000047 | WELCOME_SCREEN_IMAGE_INVALID | Image with contentId: {contentId} is not found. |
| 40000048 | COLOR_INVALID_FORMAT | Color with hex code: {hexColor} is not in correct format. |
| 40000049 | APK_TPK_MISSING | APK/TPK is missing. |
| 40000050 | APP_PLATFORM_MISSING | Application Platform is missing. |
| 40000051 | APP_SOURCE_MISSING | Application Source is missing. |
| 40000052 | INVALID_PROFILE_APP | Selected app [appTitle] is not valid for Mobile Profile. |
| 40100000 | AUTHORIZATION_FAIL | The current user is unauthorized to use this service. |
| 4040000 | RESOURCE_NOT_FOUND | RESOURCE_NOT_FOUND |
| 40400005 | DEVICES_NOT_FOUND | Device info mei/serial is required. |
| 40400007 | LICENSE_NOT_FOUND | License not found/ invalid. Provide a valid licenseKey or check whether given profile has default license. |
| 40400009 | NO_FILE_UPLOADED | No file uploaded. |
| 40400023 | UNSUPPORTED_TPK_FILE_SIZE | tpk size must not exceed than 300 MB. Please verify and upload again. |
| 50000000 | INTERNAL_SERVER_ERROR | An unknown internal server error has occurred. |
| 50000001 | CANNOT_ACCESS_KC_CMS_SERVER | An error occurred upon trying to communicate with KC CMS server. |
| 50000002 | ERROR_IN_FILE | An error occurred while reading file. |
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.
On this page
Is this page helpful?