Docs Home → MongoDB Ops Manager
Ops Manager Administration 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 Ops Manager Administration API, Ops Manager returns one of the following error codes:
Error | HTTP Code | Description |
---|---|---|
Acknowledgement comment too long. It must not exceed
<number> characters. | ||
The address <address> is already on the access list. | ||
No alert configuration with ID <ID> exists in group
<group> . | ||
No alert with ID <ID> exists in group <group> . | ||
API Keys cannot create groups. | ||
API Keys cannot create organizations. | ||
No API Key with ID {API-KEY-ID} exists. | ||
API Key access lists are only accessible by the API Key or by
a user administrator. | ||
The specified IP address does not exist in the
corresponding API key access list. | ||
The attribute <attribute> cannot be negative or zero. | ||
The attribute <attribute> cannot be negative. | ||
The attribute <attribute> is read-only and cannot be
changed by the user. | ||
Authentication mechanism <mechanism> requires SSL. | ||
Another session or user already published changes. | ||
No automation configuration exists for group <group> . | ||
No backup configuration exists for cluster <cluster> in
group <group> . | ||
User <username> is not in group <group> . | ||
No user with username <username> exists. | ||
Should not specify both the IP address and the CIDR block. | ||
Billing administrator roles are not supported by Ops Manager. | ||
The specified username <username> is not allowed. | ||
Adding a global role is not supported. | ||
Current user is not authorized to change group name. | ||
Cannot close account while the group has active backups;
please terminate all backups. | ||
Cannot close account because there are failed invoices. | ||
Cannot individually delete a snapshot that is part of a
cluster snapshot. | ||
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 the last owner of the organization. | ||
Cannot demote the last owner of the group. | ||
Cannot download a log collection request job in the
EXPIRED state. | ||
Cannot download a log collection request job in the
IN_PROGRESS state. | ||
Cannot extend duration of logs that have already expired. | ||
Cannot get backup configuration without cluster being
monitored. | ||
Cannot modify host <host> because it is managed by
Automation. | ||
Cannot modify backup configuration for individual shard; use
cluster ID <ID> for entire cluster. | ||
Cannot remove caller's IP address <address> from
access list. | ||
Username and password cannot be manually set for a managed
cluster. | ||
Cluster checkpoint interval can only be set for sharded
clusters, not replica sets. | ||
Username and password fields are only supported for
authentication mechanism MONGODB_CR or PLAIN . | ||
Cannot change password unless authentication mechanism is
MONGODB_CR or PLAIN . | ||
Setting the point in time window is not allowed. | ||
Setting the reference point time of day is not allowed. | ||
Cannot start backup unless the cluster is in the INACTIVE
or STOPPED state. | ||
Cannot start restore job for deleted cluster snapshot. | ||
Cannot start restore job for deleted snapshot. | ||
Cannot start restore job for incomplete cluster snapshot. | ||
Cannot stop backup unless the cluster is in the STARTED
state. | ||
Cannot terminate backup unless the cluster is in the
STOPPED state. | ||
No checkpoint with ID <ID> exists for cluster
<cluster> . | ||
No cluster with ID <ID> exists in group <group> . | ||
No restore job with ID <ID> exists for config server
<config server> . | ||
No snapshot with ID <ID> exists for config server
<config server> . | ||
Metric <metric> requires a database name to be provided. | ||
No database with name <name> exists on host <host> . | ||
Metric <metric> requires a device name to be provided. | ||
No device with name <name> exists on host <host> . | ||
Attribute <attribute> not allowed. To enable it, change
authentication to LDAP in Ops Manager Config. | ||
Two or more of the IP addresses being added to the access list
are the same. | ||
Each role name can only appear in one entry. <Entry> was
used more than once. | ||
Email and/or SMS must be enabled for group notifications. | ||
Email and/or SMS must be enabled for user notifications. | ||
Expiration date for log collection request job must be in
the future. | ||
Expiration date for log collection request job can only be as
far as 6 months in the future. | ||
Feature not supported by current account level. | ||
Timestamp must be whole number of seconds. | ||
No global alert configuration with ID <ID> exists. | ||
The specified event type <type> can only be used for
global alerts. | ||
A group with name <name> already exists. | ||
No group with API key <key> exists. | ||
The specified group ID <ID> does not match the URL. | ||
No group with name <name> exists. | ||
No group with ID <ID> exists. | ||
No last ping exists for host <host> in group <group> . | ||
No host with ID <ID> exists in group <group> . | ||
No host with hostname and port <name:port> exists in
group <group> . | ||
An invalid agent type name <name> was specified. | ||
An invalid alert configuration ID <ID> was specified. | ||
An invalid alert ID <ID> was specified. | ||
An invalid alert status <status> was specified. | ||
Invalid attribute <attribute> specified. | ||
Invalid authentication mechanism <mechanism> . | ||
An invalid authentication type name <name> was specified. | ||
An invalid checkpoint ID <ID> was specified. | ||
Cluster checkpoint interval must be 15, 30, or 60 minutes. | ||
An invalid cluster ID <ID> was specified. | ||
Daily snapshot retention period must be between 1 and 365
days. | ||
An invalid directory name <name> was specified. | ||
An invalid email address was specified. | ||
An invalid enumeration value <value> was specified. | ||
Event type <type> not supported for alerts. | ||
Backup configuration cannot specify both included namespaces
and excluded namespaces. | ||
An invalid granularity <granularity> was specified. | ||
An invalid group ID <ID> was specified. | ||
Group name cannot contain "10gen-" or "-10gen". | ||
An invalid group name <name> was specified. | ||
A group tag must be a string (alphanumeric, periods,
underscores, and dashes) of length <MAX_TAG_LENGTH>
characters or less. | ||
Invalid host port <number> . | ||
Invalid hostname prefix alphanumeric characters and hyphens, may not begin or end with a hyphen ("-"), and must not be more than 63 characters long. | ||
Invalid hostname <name> . | ||
An invalid restore job ID <ID> was specified. | ||
Received JSON for the <attribute> attribute does not
match expected format. | ||
Received JSON does not match expected format. | ||
An invalid key ID <ID> was specified. | ||
Log request size must be a positive number. | ||
An invalid machine ID <ID> was specified. | ||
The specified machine image is invalid. | ||
An invalid metric name <name> was specified. | ||
The username <username> is not a valid MongoDB login. | ||
Monitoring data for this process is not available. | ||
Monthly snapshot retention period must be between 1 and 36
months. | ||
Operator <operator> is not compatible with event type
<type> . | ||
An invalid period was specified. | ||
Invalid query parameter <parameter> specified. | ||
Snapshot schedule reference hour must be between 0 and 23,
inclusive. | ||
Snapshot schedule reference minute must be between 0 and 59,
inclusive. | ||
Snapshot schedule timezone offset must conform to ISO-8601
time offset format, such as "+0000". | ||
Role <role> is invalid for group <group> . | ||
An invalid snapshot ID <ID> was specified. | ||
Snapshot interval must be 6, 8, 12, or 24 hours. | ||
Snapshot retention period must be between 1 and 5 days. | ||
An invalid SSH key was specified. | ||
An invalid user ID <ID> was specified. | ||
The specified username is not a valid email address. | ||
No user <username> exists. | ||
Weekly snapshot retention period must be between 1 and 52
weeks. | ||
An invalid maintenance window ID <ID> was specified. | ||
Forbidden when either in invitation mode or using an LDAP
backend. | ||
IP address <address> is not allowed to access this
resource. | ||
No last ping exists for group <group> . | ||
Cannot set HTTP link expiration time after snapshot deletion
time. | ||
No job with the given ID exists in this group. | ||
No maintenance window with ID <ID> exists in group
<group> . | ||
Maintenance window configurations must specify a start date
before their end date. | ||
Maximum number of Ops Manager users per team exceeded while trying
to add users. Teams are limited to 250 users. | ||
Maximum number of teams per organization exceeded while
trying to add team. Organizations are limited to 250 teams. | ||
The metric threshold should only be specific for host metric
alerts. | ||
No alert configuration ID was found. | ||
The required attribute <attribute> was not specified. | ||
Authentication mechanism <mechanism> requires username
and password. | ||
Maintenance window configurations must specify at least one
alert type. | ||
Maintenance window configurations must specify an end date. | ||
Maintenance window configurations must specify a start date. | ||
A metric threshold must be specified for host metric alerts. | ||
At least one notification must be specified for an alert
configuration. | ||
Either the <attribute> attribute or the <attribute>
attribute must be specified. | ||
Either the <attribute> attribute, the <attribute>
attribute, or the <attribute> attribute must be
specified. | ||
The required attribute <attribute> was incorrectly
specified or omitted. | ||
Username cannot be changed without specifying password. | ||
The required query parameter <parameter> was not
specified. | ||
Missing <role> role or missing its value in LDAP Group
Mapping. | ||
Group notifications cannot specify an empty list of roles. | ||
Changing the storage engine will require a resync, so a sync
source must be provided. | ||
A threshold must be specified for member health alerts. | ||
Multiple groups exist with the specified name. | ||
Either the <parameter> query parameter or the
<parameter> query parameter but not both should be
specified. | ||
A suitable checkpoint could not be found for the specified
point-in time restore. | ||
No current user. | ||
No group SSH key exists for group <group> . | ||
The specified metric requires a nonzero delay for all
notifications. | ||
Host <host> is not an SCCC config server. | ||
Metric <metric> is neither a database nor a disk metric. | ||
The currently logged in user does not have the global user
administrator. | ||
The currently logged in user does not have the user
administrator role in group <group> . | ||
The current user is not in the group, or the group does not
exist. | ||
The currently logged in user does not have the administrator
role in organization <organization> . | ||
Only sharded clusters and replica sets can be patched. | ||
The currently logged in user does not have the user
administrator role for any group, team, or organization
containing user <username> . | ||
Notifications must have an internal of at least 5 minutes. | ||
At least one notification is a type that is only available
for global alert configurations. | ||
A log collection request job can only be restarted if it is
in the FAILED state. | ||
No organization with ID <ID> exists. | ||
Resource <resource> is limited to <number> requests
every <number> minutes. | ||
Cannot find resource <resource> . | ||
No restore job with ID <ID> exists in group <group> . | ||
No restore job with ID <ID> exists for cluster
<cluster> . | ||
Group-specific role <role> requires a group ID. | ||
Global role <role> cannot be specified with a group ID. | ||
Role <role> cannot be specified with an organization ID. | ||
Role <role> requires an organization ID. | ||
Roles specified for user. | ||
No snapshot with ID <ID> exists for cluster
<cluster> . | ||
A threshold should only be present for member health alerts. | ||
At most one group notification can be specified for an alert
configuration. | ||
Groups are limited to <MAX_TAGS_PER_GROUP> tags. | ||
Mode TOTAL is no longer supported. | ||
Unexpected error. | ||
Threshold units cannot be converted to metric units. | ||
Automation agent version is less than the accepted minimum
version. | ||
The specified delivery method is not supported. | ||
Operation not supported for current configuration. | ||
Operation not supported for current plan. | ||
Notification type <type> is unsupported. | ||
Setting the backup state to <state> is not supported. | ||
Cluster checkpoint interval not supported by this Backup
version; please upgrade. | ||
Excluded namespaces are not supported by this Backup
version; please upgrade. | ||
Included namespaces are not supported by this Backup
version; please upgrade. | ||
A user with username <username> already exists. | ||
No user with ID <ID> exists. | ||
User <username> is not in group <group> . | ||
Current user is not authorized to perform this action. | ||
No user with username <username> exists. | ||
The specified password is not strong enough. | ||
Webhook URL must be set in the group before adding webhook
notifications. | ||
Cannot retrieve access list for user <username> , which is not
currently logged in. | ||
IP address <address> not on access list for user
<username> . |