This help page lists the common error codes encountered when working with OpManager’s REST APIs. Each error entry includes the error code, description, and a sample response.
Description: Triggered when the provided parameter type doesn't match the expected type.
{
"error": {
"message": "The parameter 'deviceId' must be of integer type.",
"errorcode": "DATATYPE_NOT_MATCHED"
}
}Description: Occurs when a required parameter is missing or appears fewer times than required.
{
"error": {
"message": "The parameter 'deviceIds' is mandatory and must have at least 1 occurrence.",
"errorcode": "LESS_THAN_MIN_OCCURANCE"
}
}Description: Occurs when a parameter appears more times than allowed.
{
"error": {
"message": "The parameter 'deviceIds' must have at most only 5 occurrences.",
"errorcode": "MORE_THAN_MAX_OCCURANCE"
}
}Description: Occurs when the input value is shorter than the required minimum length.
{
"error": {
"message": "The parameter 'username' must have a minimum length of 3.",
"errorcode": "LESS_THAN_MIN_LENGTH"
}
}Description: Occurs when the input value exceeds the allowed maximum length.
{
"error": {
"message": "The parameter 'description' must have a maximum length of 200.",
"errorcode": "MORE_THAN_MAX_LENGTH"
}
}Description: Occurs when the input contains potentially malicious or unsafe content (XSS).
{
"error": {
"message": "Illegal input detected on the parameter 'comments'.",
"errorcode": "XSS_DETECTED"
}
}Description: Occurs when the parameter value doesn’t match the defined regex pattern.
{
"error": {
"message": "The input specified for the parameter 'email' does not match the required pattern.",
"errorcode": "PATTERN_NOT_MATCHED"
}
}Description: Occurs when the system fails to parse a parameter into its expected data type.
{
"error": {
"message": "The parameter 'port' must be of integer type.",
"errorcode": "UNABLE_TO_PARSE_DATA_TYPE"
}
}Description: Occurs when the parameter value is outside the defined numeric or logical range.
{
"error": {
"message": "The value of parameter 'age' does not fall within the expected range.",
"errorcode": "OUT_OF_RANGE"
}
}Description: Occurs when a parameter is provided but its value is empty.
{
"error": {
"message": "The parameter 'deviceName' should not be empty.",
"errorcode": "EMPTY_VALUE_NOT_ALLOWED"
}
}Description: Occurs when a request contains parameters not defined or expected by the API.
{
"error": {
"message": "Irrelevant parameter found in the request.",
"errorcode": "EXTRA_PARAM_FOUND"
}
}Description: Triggered when the requested URL does not match any configured API endpoint.
{
"error": {
"message": "The specified URL is invalid.",
"errorcode": "URL_RULE_NOT_CONFIGURED"
}
}Description: Occurs when the JSON body cannot be parsed due to syntax or format errors.
{
"error": {
"message": "Error while parsing 'deviceDetails' JSON data.",
"errorcode": "JSON_PARSE_ERROR"
}
}Description: Occurs when an array parameter size is outside the allowed range.
{
"error": {
"message": "The size of 'deviceIds' should be in the range 1-10.",
"errorcode": "ARRAY_SIZE_OUT_OF_RANGE"
}
}Description: Occurs when a required query or form parameter is missing in the request.
{
"error": {
"message": "The parameter 'action' is required to process the request.",
"errorcode": "URL_ACTION_PARAM_MISSING"
}
}Description: Occurs when the same API is accessed too frequently and exceeds the throttling limit.
{
"error": {
"message": "The API throttling limit has been exceeded. Please try again later.",
"errorcode": "URL_ROLLING_THROTTLES_LIMIT_EXCEEDED"
}
}Description: Occurs when the request uses an unsupported HTTP method (e.g., using GET instead of POST).
{
"error": {
"message": "Invalid request method.",
"errorcode": "INVALID_METHOD"
}
}Description: Occurs when a parameter value is invalid, such as out of an allowed enum list.
{
"error": {
"message": "Invalid value specified for the parameter 'status'.",
"errorcode": "INVALID_VALUE_NOT_ALLOWED"
}
}Description: Occurs when the uploaded file has an unsupported file extension.
{
"error": {
"message": "Invalid file extension.",
"errorcode": "INVALID_FILE_EXTENSION"
}
}Description: Occurs when the uploaded file's MIME type doesn’t match expected types.
{
"error": {
"message": "Unsupported file type detected.",
"errorcode": "UNMATCHED_FILE_CONTENT_TYPE"
}
}Description: Occurs when the uploaded file exceeds the maximum allowed size limit.
{
"error": {
"message": "The size of the file is greater than the maximum allowed size(1024 KB).",
"errorcode": "FILE_SIZE_MORE_THAN_ALLOWED_SIZE"
}
}Description: Occurs when an uploaded file has zero bytes.
{
"error": {
"message": "The uploaded file is empty.",
"errorcode": "EMPTY_FILE_NOT_ALLOWED"
}
}Description: Triggered when the CSRF token is invalid or expired. Applies only to browser-based requests.
{
"error": {
"message": "Problem in processing the request. Reload the page and try again.",
"errorcode": "INVALID_CSRF_TOKEN"
}
}These entries represent XML API error objects returned for various conditions. Typical HTTP status: 500.
{
"error": { "code": 5000, "message": "The specified URL is incorrect." }
}
{
"error": { "code": 5000, "message": "Specified apiKey is not valid. Authentication failed." }
}
{
"error": { "code": 5000, "message": "Internal Server Error while processing this request." }
}
{
"error": { "code": 5000, "message": "HTTP {0} request is required to perform this operation." }
}
{
"error": { "code": 5000, "message": "The parameter apiKey is not available in the request." }
}Description: Indicates that certain APIs or operations are disabled in the demo version.
{
"error": {
"message": "This feature is disabled in the demo version.",
"errorcode": "DEMO_NOT_ALLOWED"
}
}Description: Indicates that the requested URL is invalid or restricted under current settings.
{
"error": {
"message": "The requested API endpoint is not valid.",
"errorcode": "URL_INVALID"
}
}Description: Indicates that REST API usage has been disabled for the current user or setup.
{
"error": {
"message": "REST API access is disabled for this user.",
"errorcode": "REST_API_NOT_ALLOWED"
}
}Description: Occurs when a user attempts to perform an unauthorized action.
{
"error": {
"message": "The user is not authorized to perform this action.",
"errorcode": "AUTHORIZATION_FAILED"
}
}Description: Occurs when authentication credentials (such as API key or token) are invalid.
{
"error": {
"message": "Authentication failed. Invalid credentials or expired session.",
"errorcode": "AUTHENTICATION_FAILURE"
}
}