• API >
• Public API Error Codes

Public API Error Codes

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

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

Error	HTTP Code	Description
ACKNOWLEDGEMENT_COMMENT_TOO_LONG	400	Acknowledgement comment too long. It must not exceed <number> characters.
ADDRESS_ALREADY_IN_ACCESS_LIST	409	The address <address> is already on the access list.
ALERT_CONFIG_NOT_FOUND	404	No alert configuration with ID <ID> exists in group <group>.
ALERT_NOT_FOUND	404	No alert with ID <ID> exists in group <group>.
API_KEY_CANNOT_CREATE_GROUP	401	API Keys cannot create groups.
API_KEY_CANNOT_CREATE_ORG	401	API Keys cannot create organizations.
API_KEY_NOT_FOUND	400	No API Key with ID {API-KEY-ID} exists.
API_KEY_ACCESS_LIST_ACCESS_DENIED	400	API Key access lists are only accessible by the API Key or by a user administrator.
API_KEY_ACCESS_LIST_NOT_FOUND	404	The specified IP address does not exist in the corresponding API key access list.
ATTRIBUTE_NEGATIVE_OR_ZERO	400	The attribute <attribute> cannot be negative or zero.
ATTRIBUTE_NEGATIVE	400	The attribute <attribute> cannot be negative.
ATTRIBUTE_READ_ONLY	400	The attribute <attribute> is read-only and cannot be changed by the user.
AUTH_MECHANISM_REQUIRES_SSL	400	Authentication mechanism <mechanism> requires SSL.
AUTOMATION_CONFIG_CONCURRENT_MODIFICATION	409	Another session or user already published changes.
AUTOMATION_CONFIG_NOT_FOUND	404	No automation configuration exists for group <group>.
BACKUP_CONFIG_NOT_FOUND	404	No backup configuration exists for cluster <cluster> in group <group>.
BAD_USERNAME_IN_GROUP_REF	400	User <username> is not in group <group>.
BAD_USERNAME_REF	400	No user with username <username> exists.
BAD_ACCESS_LIST_ADD_REQUEST	400	Should not specify both the IP address and the CIDR block.
BILLING_UNSUPPORTED	401	Billing administrator roles are not supported by Ops Manager.
BLOCKED_USERNAME	400	The specified username <username> is not allowed.
CANNOT_ADD_GLOBAL_ROLE	403	Adding a global role is not supported.
CANNOT_CHANGE_GROUP_NAME	403	Current user is not authorized to change group name.
CANNOT_CLOSE_ACCOUNT_ACTIVE_BACKUP	409	Cannot close account while the group has active backups; please terminate all backups.
CANNOT_CLOSE_ACCOUNT_FAILED_INVOICES	402	Cannot close account because there are failed invoices.
CANNOT_DELETE_FROM_CLUSTER_SNAPSHOT	403	Cannot individually delete a snapshot that is part of a cluster snapshot.
CANNOT_DELETE_LAST_OWNER	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_ORG_OWNER	403	Cannot demote the last owner of the organization.
CANNOT_DEMOTE_LAST_OWNER	403	Cannot demote the last owner of the group.
CANNOT_DOWNLOAD_EXPIRED_JOB	403	Cannot download a log collection request job in the EXPIRED state.
CANNOT_DOWNLOAD_JOB_IN_PROGRESS	403	Cannot download a log collection request job in the IN_PROGRESS state.
CANNOT_EXTEND_EXPIRED_JOB	403	Cannot extend duration of logs that have already expired.
CANNOT_GET_BACKUP_CONFIG_INVALID_STATE	409	Cannot get backup configuration without cluster being monitored.
CANNOT_MODIFY_MANAGED_HOST	403	Cannot modify host <host> because it is managed by Automation.
CANNOT_MODIFY_SHARD_BACKUP_CONFIG	409	Cannot modify backup configuration for individual shard; use cluster ID <ID> for entire cluster.
CANNOT_REMOVE_CALLER_FROM_ACCESS_LIST	400	Cannot remove caller’s IP address <address> from access list.
CANNOT_SET_BACKUP_AUTH_FOR_MANAGED_CLUSTER	409	Username and password cannot be manually set for a managed cluster.
CANNOT_SET_CLUSTER_CHECKPOINT_INTERVAL_FOR_REPLICA_SET	400	Cluster checkpoint interval can only be set for sharded clusters, not replica sets.
CANNOT_SET_CREDENTIALS_FOR_AUTH_MECHANISM	400	Username and password fields are only supported for authentication mechanism MONGODB_CR or PLAIN.
CANNOT_SET_PASSWORD_FOR_AUTH_MECHANISM	400	Cannot change password unless authentication mechanism is MONGODB_CR or PLAIN.
CANNOT_SET_POINT_IN_TIME_WINDOW	400	Setting the point in time window is not allowed.
CANNOT_SET_REF_TIME_OF_DAY	400	Setting the reference point time of day is not allowed.
CANNOT_START_BACKUP_INVALID_STATE	409	Cannot start backup unless the cluster is in the INACTIVE or STOPPED state.
CANNOT_START_RESTORE_JOB_FOR_DELETED_CLUSTER_SNAPSHOT	409	Cannot start restore job for deleted cluster snapshot.
CANNOT_START_RESTORE_JOB_FOR_DELETED_SNAPSHOT	409	Cannot start restore job for deleted snapshot.
CANNOT_START_RESTORE_JOB_FOR_INCOMPLETE_CLUSTER_SNAPSHOT	409	Cannot start restore job for incomplete cluster snapshot.
CANNOT_STOP_BACKUP_INVALID_STATE	409	Cannot stop backup unless the cluster is in the STARTED state.
CANNOT_TERMINATE_BACKUP_INVALID_STATE	409	Cannot terminate backup unless the cluster is in the STOPPED state.
CHECKPOINT_NOT_FOUND	404	No checkpoint with ID <ID> exists for cluster <cluster>.
CLUSTER_NOT_FOUND	404	No cluster with ID <ID> exists in group <group>.
CONFIG_RESTORE_JOB_NOT_FOUND	404	No restore job with ID <ID> exists for config server <config server>.
CONFIG_SNAPSHOT_NOT_FOUND	404	No snapshot with ID <ID> exists for config server <config server>.
DATABASE_NAME_REQUIRED	400	Metric <metric> requires a database name to be provided.
DATABASE_NOT_FOUND	404	No database with name <name> exists on host <host>.
DEVICE_NAME_REQUIRED	400	Metric <metric> requires a device name to be provided.
DEVICE_NOT_FOUND	404	No device with name <name> exists on host <host>.
DISALLOWED_ATTRIBUTE_TURN_ON_LDAP	400	Attribute <attribute> not allowed. To enable it, change authentication to LDAP in Ops Manager Config.
DUPLICATE_ADDRESSES_IN_INPUT	400	Two or more of the IP addresses being added to the access list are the same.
DUPLICATE_ROLE_ENTRY_IN_LDAP_MAPPING	400	Each role name can only appear in one entry. <Entry> was used more than once.
EMAIL_OR_SMS_REQUIRED_FOR_GROUP_NOTIFICATION	400	Email and/or SMS must be enabled for group notifications.
EMAIL_OR_SMS_REQUIRED_FOR_USER_NOTIFICATION	400	Email and/or SMS must be enabled for user notifications.
EXPIRATION_DATE_MUST_BE_IN_FUTURE	400	Expiration date for log collection request job must be in the future.
EXPIRATION_DATE_TOO_DISTANT	400	Expiration date for log collection request job can only be as far as 6 months in the future.
FEATURE_UNSUPPORTED	403	Feature not supported by current account level.
FRACTIONAL_TIMESTAMP	400	Timestamp must be whole number of seconds.
GLOBAL_ALERT_CONFIG_NOT_FOUND	404	No global alert configuration with ID <ID> exists.
GLOBAL_ALERTS_ONLY	400	The specified event type <type> can only be used for global alerts.
GROUP_ALREADY_EXISTS	409	A group with name <name> already exists.
GROUP_API_KEY_NOT_FOUND	404	No group with API key <key> exists.
GROUP_MISMATCH	400	The specified group ID <ID> does not match the URL.
GROUP_NAME_NOT_FOUND	404	No group with name <name> exists.
GROUP_NOT_FOUND	404	No group with ID <ID> exists.
HOST_LAST_PING_NOT_FOUND	404	No last ping exists for host <host> in group <group>.
HOST_NOT_FOUND	404	No host with ID <ID> exists in group <group>.
HOSTNAME_AND_PORT_NOT_FOUND	404	No host with hostname and port <name:port> exists in group <group>.
INCORRECT_SNMP_PORT	400	SNMP address must be on port 162.
INVALID_AGENT_TYPE_NAME	400	An invalid agent type name <name> was specified.
INVALID_ALERT_CONFIG_ID	404	An invalid alert configuration ID <ID> was specified.
INVALID_ALERT_ID	404	An invalid alert ID <ID> was specified.
INVALID_ALERT_STATUS	400	An invalid alert status <status> was specified.
INVALID_ATTRIBUTE	400	Invalid attribute <attribute> specified.
INVALID_AUTH_MECHANISM	400	Invalid authentication mechanism <mechanism>.
INVALID_AUTH_TYPE_NAME	400	An invalid authentication type name <name> was specified.
INVALID_CHECKPOINT_ID	404	An invalid checkpoint ID <ID> was specified.
INVALID_CLUSTER_CHECKPOINT_INTERVAL	400	Cluster checkpoint interval must be 15, 30, or 60 minutes.
INVALID_CLUSTER_ID	404	An invalid cluster ID <ID> was specified.
INVALID_DAILY_SNAPSHOT_RETENTION_PERIOD	400	Daily snapshot retention period must be between 1 and 365 days.
INVALID_DIRECTORY	400	An invalid directory name <name> was specified.
INVALID_EMAIL_ADDRESS	400	An invalid email address was specified.
INVALID_ENUM_VALUE	400	An invalid enumeration value <value> was specified.
INVALID_EVENT_TYPE_FOR_ALERT	400	Event type <type> not supported for alerts.
INVALID_FILTERLIST	400	Backup configuration cannot specify both included namespaces and excluded namespaces.
INVALID_FLOWDOCK_FLOW_NAME	400	Flowdock flow name cannot contain spaces.
INVALID_GRANULARITY	400	An invalid granularity <granularity> was specified.
INVALID_GROUP_ID	404	An invalid group ID <ID> was specified.
INVALID_GROUP_NAME_10GEN	400	Group name cannot contain “10gen-” or “-10gen”.
INVALID_GROUP_NAME	400	An invalid group name <name> was specified.
INVALID_GROUP_TOKEN	400	A group tag must be a string (alphanumeric, periods, underscores, and dashes) of length <MAX_TAG_LENGTH> characters or less.
INVALID_HOST_PORT	400	Invalid host port <number>.
INVALID_HOSTNAME_PREFIX	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	400	Invalid hostname <name>.
INVALID_JOB_ID	404	An invalid restore job ID <ID> was specified.
INVALID_JSON_ATTRIBUTE	400	Received JSON for the <attribute> attribute does not match expected format.
INVALID_JSON	400	Received JSON does not match expected format.
INVALID_KEY_ID	404	An invalid key ID <ID> was specified.
INVALID_LOG_REQUEST_SIZE	400	Log request size must be a positive number.
INVALID_MACHINE_ID	404	An invalid machine ID <ID> was specified.
INVALID_MACHINE_IMAGE	400	The specified machine image is invalid.
INVALID_METRIC_NAME	404	An invalid metric name <name> was specified.
INVALID_MONGODB_USERNAME	400	The username <username> is not a valid MongoDB login.
INVALID_MONITORING_STATE	409	Monitoring data for this process is not available.
INVALID_MONTHLY_SNAPSHOT_RETENTION_PERIOD	400	Monthly snapshot retention period must be between 1 and 36 months.
INVALID_OPERATOR_FOR_EVENT_TYPE	400	Operator <operator> is not compatible with event type <type>.
INVALID_PERIOD	400	An invalid period was specified.
INVALID_QUERY_PARAMETER	400	Invalid query parameter <parameter> specified.
INVALID_REFERENCE_HOUR_OF_DAY	400	Snapshot schedule reference hour must be between 0 and 23, inclusive.
INVALID_REFERENCE_MINUTE_OF_HOUR	400	Snapshot schedule reference minute must be between 0 and 59, inclusive.
INVALID_REFERENCE_TIMEZONE_OFFSET	400	Snapshot schedule timezone offset must conform to ISO-8601 time offset format, such as “+0000”.
INVALID_ROLE_FOR_GROUP	400	Role <role> is invalid for group <group>.
INVALID_SNAPSHOT_ID	404	An invalid snapshot ID <ID> was specified.
INVALID_SNAPSHOT_INTERVAL	400	Snapshot interval must be 6, 8, 12, or 24 hours.
INVALID_SNAPSHOT_RETENTION_PERIOD	400	Snapshot retention period must be between 1 and 5 days.
INVALID_SSH_KEY	400	An invalid SSH key was specified.
INVALID_USER_ID	404	An invalid user ID <ID> was specified.
INVALID_USERNAME	400	The specified username is not a valid email address.
INVALID_USER	400	No user <username> exists.
INVALID_WEEKLY_SNAPSHOT_RETENTION_PERIOD	400	Weekly snapshot retention period must be between 1 and 52 weeks.
INVALID_WINDOW_ID	404	An invalid maintenance window ID <ID> was specified.
INVITATION_ONLY_MODE_OR_LDAP	403	Forbidden when either in invitation mode or using an LDAP backend.
IP_ADDRESS_NOT_ON_ACCESS_LIST	403	IP address <address> is not allowed to access this resource.
LAST_PING_NOT_FOUND	404	No last ping exists for group <group>.
LINK_EXPIRATION_AFTER_SNAPSHOT_DELETION	409	Cannot set HTTP link expiration time after snapshot deletion time.
	404	No job with the given ID exists in this group.
MAINTENANCE_WINDOW_NOT_FOUND	404	No maintenance window with ID <ID> exists in group <group>.
MAINTENANCE_WINDOW_START_DATE_AFTER_END_DATE	400	Maintenance window configurations must specify a start date before their end date.
MAX_USERS_PER_TEAM_EXCEEDED	400	Maximum number of Ops Manager users per team exceeded while trying to add users. Teams are limited to 250 users.
MAX_TEAMS_PER_ORG_EXCEEDED	400	Maximum number of teams per organization exceeded while trying to add team. Organizations are limited to 250 teams.
METRIC_THRESHOLD_PRESENT	400	The metric threshold should only be specific for host metric alerts.
MISSING_ALERT_CONFIG_ID	404	No alert configuration ID was found.
MISSING_ATTRIBUTE	400	The required attribute <attribute> was not specified.
MISSING_CREDENTIALS_FOR_AUTH_MECHANISM	400	Authentication mechanism <mechanism> requires username and password.
MISSING_MAINTENANCE_WINDOW_ALERT_TYPE_NAME	400	Maintenance window configurations must specify at least one alert type.
MISSING_MAINTENANCE_WINDOW_END_DATE	400	Maintenance window configurations must specify an end date.
MISSING_MAINTENANCE_WINDOW_START_DATE	400	Maintenance window configurations must specify a start date.
MISSING_METRIC_THRESHOLD	400	A metric threshold must be specified for host metric alerts.
MISSING_NOTIFICATIONS	400	At least one notification must be specified for an alert configuration.
MISSING_ONE_OF_ATTRIBUTES	400	Either the <attribute> attribute or the <attribute> attribute must be specified.
MISSING_ONE_OF_THREE_ATTRIBUTES	400	Either the <attribute> attribute, the <attribute> attribute, or the <attribute> attribute must be specified.
MISSING_OR_INVALID_ATTRIBUTE	400	The required attribute <attribute> was incorrectly specified or omitted.
MISSING_PASSWORD	400	Username cannot be changed without specifying password.
MISSING_QUERY_PARAMETER	400	The required query parameter <parameter> was not specified.
MISSING_ROLE_ENTRY_IN_LDAP_MAPPING	400	Missing <role> role or missing its value in LDAP Group Mapping.
MISSING_ROLES_FOR_GROUP_NOTIFICATION	400	Group notifications cannot specify an empty list of roles.
MISSING_SYNC_SOURCE	409	Changing the storage engine will require a resync, so a sync source must be provided.
MISSING_THRESHOLD	400	A threshold must be specified for member health alerts.
MULTIPLE_GROUPS	409	Multiple groups exist with the specified name.
MUTUALLY_EXCLUSIVE_QUERY_PARAMETERS	400	Either the <parameter> query parameter or the <parameter> query parameter but not both should be specified.
NO_CHECKPOINT_FOR_PIT_RESTORE	409	A suitable checkpoint could not be found for the specified point-in time restore.
NO_CURRENT_USER	401	No current user.
NO_GROUP_SSH_KEY	409	No group SSH key exists for group <group>.
NONZERO_DELAY_REQUIRED	400	The specified metric requires a nonzero delay for all notifications.
NOT_CONFIG_SERVER	404	Host <host> is not an SCCC config server.
NOT_DATABASE_OR_DISK_METRIC	404	Metric <metric> is neither a database nor a disk metric.
NOT_GLOBAL_USER_ADMIN	401	The currently logged in user does not have the global user administrator.
NOT_GROUP_USER_ADMIN	401	The currently logged in user does not have the user administrator role in group <group>.
NOT_IN_GROUP	401	The current user is not in the group, or the group does not exist.
NOT_ORG_ADMIN	401	The currently logged in user does not have the administrator role in organization <organization>.
NOT_SHARDED	400	Only sharded clusters and replica sets can be patched.
NOT_USER_ADMIN	401	The currently logged in user does not have the user administrator role for any group, team, or organization containing user <username>.
NOTIFICATION_INTERVAL_OUT_OF_RANGE	400	Notifications must have an internal of at least 5 minutes.
NOTIFICATION_TYPE_IS_GLOBAL_ONLY	400	At least one notification is a type that is only available for global alert configurations.
ONLY_FAILED_JOB_CAN_BE_RESTARTED	400	A log collection request job can only be restarted if it is in the FAILED state.
ORG_NOT_FOUND	404	No organization with ID <ID> exists.
RATE_LIMITED	429	Resource <resource> is limited to <number> requests every <number> minutes.
RESOURCE_NOT_FOUND	404	Cannot find resource <resource>.
RESTORE_JOB_NOT_FOUND_IN_GROUP	404	No restore job with ID <ID> exists in group <group>.
RESTORE_JOB_NOT_FOUND	404	No restore job with ID <ID> exists for cluster <cluster>.
ROLE_NEEDS_GROUP_ID	400	Group-specific role <role> requires a group ID.
ROLE_NEEDS_NO_GROUP_ID	400	Global role <role> cannot be specified with a group ID.
ROLE_NEEDS_NO_ORG_ID	400	Role <role> cannot be specified with an organization ID.
ROLE_NEEDS_ORG_ID	400	Role <role> requires an organization ID.
ROLES_SPECIFIED_FOR_USER	403	Roles specified for user.
SNAPSHOT_NOT_FOUND	404	No snapshot with ID <ID> exists for cluster <cluster>.
THRESHOLD_PRESENT	400	A threshold should only be present for member health alerts.
TOO_MANY_GROUP_NOTIFICATIONS	400	At most one group notification can be specified for an alert configuration.
TOO_MANY_GROUP_TOKENS	400	Groups are limited to <MAX_TAGS_PER_GROUP> tags.
TOTAL_MODE_DEPRECATED	400	Mode TOTAL is no longer supported.
UNEXPECTED_ERROR	500	Unexpected error.
UNITS_MISMATCH	400	Threshold units cannot be converted to metric units.
UNSUPPORTED_AUTOMATION_AGENT_VERSION		Automation agent version is less than the accepted minimum version.
UNSUPPORTED_DELIVERY_METHOD	400	The specified delivery method is not supported.
UNSUPPORTED_FOR_CURRENT_CONFIG	403	Operation not supported for current configuration.
UNSUPPORTED_FOR_CURRENT_PLAN	403	Operation not supported for current plan.
UNSUPPORTED_NOTIFICATION_TYPE	400	Notification type <type> is unsupported.
UNSUPPORTED_SET_BACKUP_STATE	403	Setting the backup state to <state> is not supported.
UPGRADE_FOR_CLUSTER_CHECKPOINT_INTERVAL	409	Cluster checkpoint interval not supported by this Backup version; please upgrade.
UPGRADE_FOR_EXCLUDED_NAMESPACES	409	Excluded namespaces are not supported by this Backup version; please upgrade.
UPGRADE_FOR_INCLUDED_NAMESPACES	409	Included namespaces are not supported by this Backup version; please upgrade.
USER_ALREADY_EXISTS	409	A user with username <username> already exists.
USER_NOT_FOUND	404	No user with ID <ID> exists.
USER_NOT_IN_GROUP	404	User <username> is not in group <group>.
USER_UNAUTHORIZED	401	Current user is not authorized to perform this action.
USERNAME_NOT_FOUND	404	No user with username <username> exists.
WEAK_PASSWORD	400	The specified password is not strong enough.
WEBHOOK_URL_NOT_SET	400	Webhook URL must be set in the group before adding webhook notifications.
ACCESS_LIST_ACCESS_DENIED	401	Cannot retrieve access list for user <username>, which is not currently logged in.
ACCESS_LIST_NOT_FOUND	404	IP address <address> not on access list for user <username>.

←   Return the Status of the Connection between Organizations Configure API Access  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.