Navigation
  • API >
  • Public API Error Codes

Public API Error Codes

If you encounter an error when issuing a request to the Public API, Ops Manager returns one of the following error codes:

ACKNOWLEDGEMENT_COMMENT_TOO_LONG

HTTP 400

Acknowledgement comment too long. It must not exceed <number> characters.

ADDRESS_ALREADY_IN_WHITELIST

HTTP 409

The address <address> is already on the whitelist.

ALERT_CONFIG_NOT_FOUND

HTTP 404

No alert configuration with ID <ID> exists in group <group>.

ALERT_NOT_FOUND

HTTP 404

No alert with ID <ID> exists in group <group>.

ATTRIBUTE_NEGATIVE_OR_ZERO

HTTP 400

The attribute <attribute> cannot be negative or zero.

ATTRIBUTE_NEGATIVE

HTTP 400

The attribute <attribute> cannot be negative.

ATTRIBUTE_READ_ONLY

HTTP 400

The attribute <attribute> is read-only and cannot be changed by the user.

AUTH_MECHANISM_REQUIRES_SSL

HTTP 400

Authentication mechanism <mechanism> requires SSL.

AUTOMATION_CONFIG_NOT_FOUND

HTTP 404

No automation configuration exists for group <group>.

BACKUP_CONFIG_NOT_FOUND

HTTP 404

No backup configuration exists for cluster <cluster> in group <group>.

BAD_USERNAME_IN_GROUP_REF

HTTP 400

User <username> is not in group <group>.

BAD_USERNAME_REF

HTTP 400

No user with username <username> exists.

BAD_WHITELIST_ADD_REQUEST

HTTP 400

Should not specify both the IP address and the CIDR block.

BILLING_UNSUPPORTED

HTTP 401

Billing administrator roles are not supported by Ops Manager.

BLOCKED_USERNAME

HTTP 400

The specified username <username> is not allowed.

CANNOT_ADD_GLOBAL_ROLE

HTTP 403

Adding a global role is not supported.

CANNOT_CHANGE_GROUP_NAME

HTTP 403

Current user is not authorized to change group name.

CANNOT_CLOSE_ACCOUNT_ACTIVE_BACKUP

HTTP 409

Cannot close account while the group has active backups; please terminate all backups.

CANNOT_CLOSE_ACCOUNT_FAILED_INVOICES

HTTP 402

Cannot close account because there are failed invoices.

CANNOT_DELETE_FROM_CLUSTER_SNAPSHOT

HTTP 403

Cannot individually delete a snapshot that is part of a cluster snapshot.

CANNOT_DELETE_LAST_OWNER

HTTP 403

Cannot remove the last owner from the group. If you are trying to close the group by removing all users, please delete the group instead.

CANNOT_DEMOTE_LAST_OWNER

HTTP 403

Cannot demote the last owner of the group.

CANNOT_GET_BACKUP_CONFIG_INVALID_STATE

HTTP 409

Cannot get backup configuration without cluster being monitored.

CANNOT_MODIFY_MANAGED_HOST

HTTP 403

Cannot modify host <host> because it is managed by Automation.

CANNOT_MODIFY_SHARD_BACKUP_CONFIG

HTTP 409

Cannot modify backup configuration for individual shard; use cluster ID <ID> for entire cluster.

CANNOT_REMOVE_CALLER_FROM_WHITELIST

HTTP 400

Cannot remove caller’s IP address <address> from whitelist.

CANNOT_SET_BACKUP_AUTH_FOR_MANAGED_CLUSTER

HTTP 409

Username and password cannot be manually set for a managed cluster.

CANNOT_SET_CLUSTER_CHECKPOINT_INTERVAL_FOR_REPLICA_SET

HTTP 400

Cluster checkpoint interval can only be set for sharded clusters, not replica sets.

CANNOT_SET_CREDENTIALS_FOR_AUTH_MECHANISM

HTTP 400

Username and password fields are only supported for authentication mechanism MONGODB_CR or PLAIN.

CANNOT_SET_PASSWORD_FOR_AUTH_MECHANISM

HTTP 400

Cannot change password unless authentication mechanism is MONGODB_CR or PLAIN.

CANNOT_SET_POINT_IN_TIME_WINDOW

HTTP 400

Setting the point in time window is not allowed.

CANNOT_SET_REF_TIME_OF_DAY

HTTP 400

Setting the reference point time of day is not allowed.

CANNOT_START_BACKUP_INVALID_STATE

HTTP 409

Cannot start backup unless the cluster is in the INACTIVE or STOPPED state.

CANNOT_START_RESTORE_JOB_FOR_DELETED_CLUSTER_SNAPSHOT

HTTP 409

Cannot start restore job for deleted cluster snapshot.

CANNOT_START_RESTORE_JOB_FOR_DELETED_SNAPSHOT

HTTP 409

Cannot start restore job for deleted snapshot.

CANNOT_START_RESTORE_JOB_FOR_INCOMPLETE_CLUSTER_SNAPSHOT

HTTP 409

Cannot start restore job for incomplete cluster snapshot.

CANNOT_STOP_BACKUP_INVALID_STATE

HTTP 409

Cannot stop backup unless the cluster is in the STARTED state.

CANNOT_TERMINATE_BACKUP_INVALID_STATE

HTTP 409

Cannot terminate backup unless the cluster is in the STOPPED state.

CHECKPOINT_NOT_FOUND

HTTP 404

No checkpoint with ID <ID> exists for cluster <cluster>.

CLUSTER_NOT_FOUND

HTTP 404

No cluster with ID <ID> exists in group <group>.

CONFIG_RESTORE_JOB_NOT_FOUND

HTTP 404

No restore job with ID <ID> exists for config server <config server>.

CONFIG_SNAPSHOT_NOT_FOUND

HTTP 404

No snapshot with ID <ID> exists for config server <config server>.

DATABASE_NAME_REQUIRED

HTTP 400

Metric <metric> requires a database name to be provided.

DATABASE_NOT_FOUND

HTTP 404

No database with name <name> exists on host <host>.

DEVICE_NAME_REQUIRED

HTTP 400

Metric <metric> requires a device name to be provided.

DEVICE_NOT_FOUND

HTTP 404

No device with name <name> exists on host <host>.

DISALLOWED_ATTRIBUTE_TURN_ON_LDAP

HTTP 400

Attribute <attribute> not allowed. To enable it, change authentication to LDAP in Ops Manager Config.

DUPLICATE_ADDRESSES_IN_INPUT

HTTP 400

Two or more of the IP addresses being added to the whitelist are the same.

DUPLICATE_ROLE_ENTRY_IN_LDAP_MAPPING

HTTP 400

Each role name can only appear in one entry. <Entry> was used more than once.

EMAIL_OR_SMS_REQUIRED_FOR_GROUP_NOTIFICATION

HTTP 400

Email and/or SMS must be enabled for group notifications.

EMAIL_OR_SMS_REQUIRED_FOR_USER_NOTIFICATION

HTTP 400

Email and/or SMS must be enabled for user notifications.

FEATURE_UNSUPPORTED

HTTP 403

Feature not supported by current account level.

FRACTIONAL_TIMESTAMP

HTTP 400

Timestamp must be whole number of seconds.

GLOBAL_ALERT_CONFIG_NOT_FOUND

HTTP 404

No global alert configuration with ID <ID> exists.

GLOBAL_ALERTS_ONLY

HTTP 400

The specified event type <type> can only be used for global alerts.

GROUP_ALREADY_EXISTS

HTTP 409

A group with name <name> already exists.

GROUP_API_KEY_NOT_FOUND

HTTP 404

No group with API key <key> exists.

GROUP_MISMATCH

HTTP 400

The specified group ID <ID> does not match the URL.

GROUP_NAME_NOT_FOUND

HTTP 404

No group with name <name> exists.

GROUP_NOT_FOUND

HTTP 404

No group with ID <ID> exists.

HOST_LAST_PING_NOT_FOUND

HTTP 404

No last ping exists for host <host> in group <group>.

HOST_NOT_FOUND

HTTP 404

No host with ID <ID> exists in group <group>.

HOSTNAME_AND_PORT_NOT_FOUND

HTTP 404

No host with hostname and port <name:port> exists in group <group>.

INCORRECT_SNMP_PORT

HTTP 400

SNMP address must be on port 162.

INVALID_AGENT_TYPE_NAME

HTTP 400

An invalid agent type name <name> was specified.

INVALID_ALERT_CONFIG_ID

HTTP 404

An invalid alert configuration ID <ID> was specified.

INVALID_ALERT_ID

HTTP 404

An invalid alert ID <ID> was specified.

INVALID_ALERT_STATUS

HTTP 400

An invalid alert status <status> was specified.

INVALID_ATTRIBUTE

HTTP 400

Invalid attribute <attribute> specified.

INVALID_AUTH_MECHANISM

HTTP 400

Invalid authentication mechanism <mechanism>.

INVALID_AUTH_TYPE_NAME

HTTP 400

An invalid authentication type name <name> was specified.

INVALID_CHECKPOINT_ID

HTTP 404

An invalid checkpoint ID <ID> was specified.

INVALID_CLUSTER_CHECKPOINT_INTERVAL

HTTP 400

Cluster checkpoint interval must be 15, 30, or 60 minutes.

INVALID_CLUSTER_ID

HTTP 404

An invalid cluster ID <ID> was specified.

INVALID_DAILY_SNAPSHOT_RETENTION_PERIOD

HTTP 400

Daily snapshot retention period must be between 1 and 365 days.

INVALID_DIRECTORY

HTTP 400

An invalid directory name <name> was specified.

INVALID_EMAIL_ADDRESS

HTTP 400

An invalid email address was specified.

INVALID_ENUM_VALUE

HTTP 400

An invalid enumeration value <value> was specified.

INVALID_EVENT_TYPE_FOR_ALERT

HTTP 400

Event type <type> not supported for alerts.

INVALID_FILTERLIST

HTTP 400

Backup configuration cannot specify both included namespaces and excluded namespaces.

INVALID_FLOWDOCK_FLOW_NAME

HTTP 400

Flowdock flow name cannot contain spaces.

INVALID_GRANULARITY

HTTP 400

An invalid granularity <granularity> was specified.

INVALID_GROUP_ID

HTTP 404

An invalid group ID <ID> was specified.

INVALID_GROUP_NAME_10GEN

HTTP 400

Group name cannot contain “10gen-” or “-10gen”.

INVALID_GROUP_NAME

HTTP 400

An invalid group name <name> was specified.

INVALID_GROUP_TOKEN

HTTP 400

A group tag must be a string (alphanumeric, periods, underscores, and dashes) of length ” + GroupSvc.MAX_TAG_LENGTH + ” characters or less.

INVALID_HOST_PORT

HTTP 400

Invalid host port <number>.

INVALID_HOSTNAME_PREFIX

HTTP 400

Invalid hostname prefix <prefix>. It must contain only alphanumeric characters and hyphens, may not begin or end with a hyphen (“-“), and must not be more than 63 characters long.

INVALID_HOSTNAME

HTTP 400

Invalid hostname <name>.

INVALID_JOB_ID

HTTP 404

An invalid restore job ID <ID> was specified.

INVALID_JSON_ATTRIBUTE

HTTP 400

Received JSON for the <attribute> attribute does not match expected format.

INVALID_JSON

HTTP 400

Received JSON does not match expected format.

INVALID_KEY_ID

HTTP 404

An invalid key ID <ID> was specified.

INVALID_MACHINE_ID

HTTP 404

An invalid machine ID <ID> was specified.

INVALID_MACHINE_IMAGE

HTTP 400

The specified machine image is invalid.

INVALID_METRIC_NAME

HTTP 404

An invalid metric name <name> was specified.

INVALID_MONGODB_USERNAME

HTTP 400

The username <username> is not a valid MongoDB login.

INVALID_MONTHLY_SNAPSHOT_RETENTION_PERIOD

HTTP 400

Monthly snapshot retention period must be between 1 and 36 months.

INVALID_OPERATOR_FOR_EVENT_TYPE

HTTP 400

Operator <operator> is not compatible with event type <type>.

INVALID_PERIOD

HTTP 400

An invalid period was specified.

INVALID_QUERY_PARAMETER

HTTP 400

Invalid query parameter <parameter> specified.

INVALID_REFERENCE_HOUR_OF_DAY

HTTP 400

Snapshot schedule reference hour must be between 0 and 23, inclusive.

INVALID_REFERENCE_MINUTE_OF_HOUR

HTTP 400

Snapshot schedule reference minute must be between 0 and 59, inclusive.

INVALID_REFERENCE_TIMEZONE_OFFSET

HTTP 400

Snapshot schedule timezone offset must conform to ISO-8601 time offset format, such as “+0000”.

INVALID_ROLE_FOR_GROUP

HTTP 400

Role <role> is invalid for group <group>.

INVALID_SERVER_POOL_SERVER_ID

HTTP 400

An invalid server pool server ID <ID> was specified.

INVALID_SERVER_POOL_SERVER_HOSTNAME

HTTP 400

An invalid server pool server hostname <hostname> was specified.

INVALID_SNAPSHOT_ID

HTTP 404

An invalid snapshot ID <ID> was specified.

INVALID_SNAPSHOT_INTERVAL

HTTP 400

Snapshot interval must be 6, 8, 12, or 24 hours.

INVALID_SNAPSHOT_RETENTION_PERIOD

HTTP 400

Snapshot retention period must be between 1 and 5 days.

INVALID_SSH_KEY

HTTP 400

An invalid SSH key was specified.

INVALID_USER_ID

HTTP 404

An invalid user ID <ID> was specified.

INVALID_USERNAME

HTTP 400

The specified username is not a valid email address.

INVALID_USER

HTTP 400

No user <username> exists.

INVALID_WEEKLY_SNAPSHOT_RETENTION_PERIOD

HTTP 400

Weekly snapshot retention period must be between 1 and 52 weeks.

INVALID_WINDOW_ID

HTTP 404

An invalid maintenance window ID <ID> was specified.

INVITATION_ONLY_MODE_OR_LDAP

HTTP 403

Forbidden when either in invitation mode or using an LDAP backend.

IP_ADDRESS_NOT_ON_WHITELIST

HTTP 403

IP address <address> is not allowed to access this resource.

LAST_PING_NOT_FOUND

HTTP 404

No last ping exists for group <group>.

HTTP 409

Cannot set HTTP link expiration time after snapshot deletion time.

MAINTENANCE_WINDOW_NOT_FOUND

HTTP 404

No maintenance window with ID <ID> exists in group <group>.

MAINTENANCE_WINDOW_START_DATE_AFTER_END_DATE

HTTP 400

Maintenance window configurations must specify a start date before their end date.

METRIC_THRESHOLD_PRESENT

HTTP 400

The metric threshold should only be specific for host metric alerts.

MISSING_ALERT_CONFIG_ID

HTTP 404

No alert configuration ID was found.

MISSING_ATTRIBUTE

HTTP 400

The required attribute <attribute> was not specified.

MISSING_CREDENTIALS_FOR_AUTH_MECHANISM

HTTP 400

Authentication mechanism <mechanism> requires username and password.

MISSING_MAINTENANCE_WINDOW_ALERT_TYPE_NAME

HTTP 400

Maintenance window configurations must specify at least one alert type.

MISSING_MAINTENANCE_WINDOW_END_DATE

HTTP 400

Maintenance window configurations must specify an end date.

MISSING_MAINTENANCE_WINDOW_START_DATE

HTTP 400

Maintenance window configurations must specify a start date.

MISSING_METRIC_THRESHOLD

HTTP 400

A metric threshold must be specified for host metric alerts.

MISSING_NOTIFICATIONS

HTTP 400

At least one notification must be specified for an alert configuration.

MISSING_ONE_OF_ATTRIBUTES

HTTP 400

Either the <attribute> attribute or the <attribute> attribute must be specified.

MISSING_ONE_OF_THREE_ATTRIBUTES

HTTP 400

Either the <attribute> attribute, the <attribute> attribute, or the <attribute> attribute must be specified.

MISSING_OR_INVALID_ATTRIBUTE

HTTP 400

The required attribute <attribute> was incorrectly specified or omitted.

MISSING_PASSWORD

HTTP 400

Username cannot be changed without specifying password.

MISSING_QUERY_PARAMETER

HTTP 400

The required query parameter <parameter> was not specified.

MISSING_ROLE_ENTRY_IN_LDAP_MAPPING

HTTP 400

Missing <role> role or missing its value in LDAP Group Mapping.

MISSING_ROLES_FOR_GROUP_NOTIFICATION

HTTP 400

Group notifications cannot specify an empty list of roles.

MISSING_SYNC_SOURCE

HTTP 409

Changing the storage engine will require a resync, so a sync source must be provided.

MISSING_THRESHOLD

HTTP 400

A threshold must be specified for member health alerts.

MUTUALLY_EXCLUSIVE_QUERY_PARAMETERS

HTTP 400

Either the <parameter> query parameter or the <parameter> query parameter but not both should be specified.

NO_CHECKPOINT_FOR_PIT_RESTORE

HTTP 409

A suitable checkpoint could not be found for the specified point-in-time restore.

NO_CURRENT_USER

HTTP 401

No current user.

NO_GROUP_SSH_KEY

HTTP 409

No group SSH key exists for group <group>.

NONZERO_DELAY_REQUIRED

HTTP 400

The specified metric requires a nonzero delay for all notifications.

NOT_CONFIG_SERVER

HTTP 404

Host <host> is not an SCCC config server.

NOT_DATABASE_OR_DISK_METRIC

HTTP 404

Metric <metric> is neither a database nor a disk metric.

NOT_GLOBAL_USER_ADMIN

HTTP 401

The currently logged in user does not have the global user administrator.

NOT_GROUP_USER_ADMIN

HTTP 401

The currently logged in user does not have the user administrator role in group <group>.

NOT_IN_GROUP

HTTP 401

The current user is not in the group, or the group does not exist.

NOT_SHARDED

HTTP 400

Only sharded clusters and replica sets can be patched.

NOT_USER_ADMIN

HTTP 401

The currently logged in user does not have the user administrator role for any group containing user <username>.

NOTIFICATION_INTERVAL_OUT_OF_RANGE

HTTP 400

Notifications must have an internal of at least 5 minutes.

NOTIFICATION_TYPE_IS_GLOBAL_ONLY

HTTP 400

At least one notification is a type that is only available for global alert configurations.

RATE_LIMITED

HTTP 429

Resource <resource> is limited to <number> requests every <number> minutes.

RESOURCE_NOT_FOUND

HTTP 404

Cannot find resource <resource>.

RESTORE_JOB_NOT_FOUND_IN_GROUP

HTTP 404

No restore job with ID <ID> exists in group <group>.

RESTORE_JOB_NOT_FOUND

HTTP 404

No restore job with ID <ID> exists for cluster <cluster>.

ROLE_NEEDS_GROUP_ID

HTTP 400

Group-specific role <role> requires a group ID.

ROLE_NEEDS_NO_GROUP_ID

HTTP 400

Global role <role> cannot be specified with a group ID.

ROLES_SPECIFIED_FOR_USER

HTTP 403

Roles specified for user.

SERVER_POOL_SERVER_HOSTNAME_NOT_FOUND

HTTP 404

An invalid server pool server hostname <name> was specified.

SERVER_POOL_SERVER_ID_NOT_FOUND

HTTP 404

An invalid server pool server ID <ID> was specified.

SERVER_POOL_SERVER_INVALID_STATE

HTTP 409

The specified server <server> cannot be deleted with an invalid state.

SNAPSHOT_NOT_FOUND

HTTP 404

No snapshot with ID <ID> exists for cluster <cluster>.

THRESHOLD_PRESENT

HTTP 400

A threshold should only be present for member health alerts.

TOO_MANY_GROUP_NOTIFICATIONS

HTTP 400

At most one group notification can be specified for an alert configuration.

TOO_MANY_GROUP_TOKENS

HTTP 400

Groups are limited to ” + GroupSvc.MAX_TAGS_PER_GROUP + ” tags.

TOTAL_MODE_DEPRECATED

HTTP 400

Mode TOTAL is no longer supported.

UNEXPECTED_ERROR

HTTP 500

Unexpected error.

UNITS_MISMATCH

HTTP 400

Threshold units cannot be converted to metric units.

UNSUPPORTED_DELIVERY_METHOD

HTTP 400

The specified delivery method is not supported.

UNSUPPORTED_FOR_CURRENT_CONFIG

HTTP 403

Operation not supported for current configuration.

UNSUPPORTED_FOR_CURRENT_PLAN

HTTP 403

Operation not supported for current plan.

UNSUPPORTED_NOTIFICATION_TYPE

HTTP 400

Notification type <type> is unsupported.

UNSUPPORTED_SET_BACKUP_STATE

HTTP 403

Setting the backup state to <state> is not supported.

UPGRADE_FOR_CLUSTER_CHECKPOINT_INTERVAL

HTTP 409

Cluster checkpoint interval not supported by this Backup Agent version; please upgrade.

UPGRADE_FOR_EXCLUDED_NAMESPACES

HTTP 409

Excluded namespaces are not supported by this Backup Agent version; please upgrade.

UPGRADE_FOR_INCLUDED_NAMESPACES

HTTP 409

Included namespaces are not supported by this Backup Agent version; please upgrade.

USER_ALREADY_EXISTS

HTTP 409

A user with username <username> already exists.

USER_NOT_FOUND

HTTP 404

No user with ID <ID> exists.

USER_NOT_IN_GROUP

HTTP 404

User <username> is not in group <group>.

USER_UNAUTHORIZED

HTTP 401

Current user is not authorized to perform this action.

USERNAME_NOT_FOUND

HTTP 404

No user with username <username> exists.

WEAK_PASSWORD

HTTP 400

The specified password is not strong enough.

WEBHOOK_URL_NOT_SET

HTTP 400

Webhook URL must be set in the group before adding webhook notifications.

WHITELIST_ACCESS_DENIED

HTTP 401

Cannot access whitelist for user <username>, which is not currently logged in.

WHITELIST_NOT_FOUND

HTTP 404

IP address <address> not on whitelist for user <username>.