- 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, Cloud Manager returns one of the following error codes:
Error | HTTP Code | Description |
---|---|---|
|
402 | Group has an unpaid invoice that is more than 30 days old. |
|
400 | Acknowledgement comment too long. It must not exceed
<number> characters. |
|
409 | The address <address> is already on the whitelist. |
|
404 | No alert configuration with ID <ID> exists in group
<group> . |
|
404 | No alert with ID <ID> exists in group <group> . |
|
401 | API Keys cannot create groups. |
|
401 | API Keys cannot create organizations. |
|
400 | No API Key with ID {API-KEY-ID} exists. |
|
400 | API Key whitelists are only accessible by the API Key itself or by a user administrator. |
|
404 | The specified IP address does not exist in the corresponding API Key whitelist. |
|
400 | The attribute <attribute> cannot be negative or zero. |
|
400 | The attribute <attribute> cannot be negative. |
|
400 | The attribute <attribute> is read-only and cannot be
changed by the user. |
|
400 | Authentication mechanism <mechanism> requires SSL. |
|
404 | No automation configuration exists for group <group> . |
|
404 | No backup configuration exists for cluster <cluster> in
group <group> . |
|
400 | User <username> is not in group <group> . |
|
400 | No user with username <username> exists. |
|
400 | Should not specify both the IP address and the CIDR block. |
|
400 | The specified username <username> is not allowed. |
|
400 | The specified address cannot be added to whitelists.
Cloud Manager does not allow certain IP addresses to be
whitelisted, such as 0.0.0.0/32 . |
|
403 | Adding a global role is not supported. |
|
403 | Current user is not authorized to change group name. |
|
409 | Cannot close account while the group has active backups; please terminate all backups. |
|
402 | Cannot close account because there are failed invoices. |
|
403 | Cannot individually delete a snapshot that is part of a cluster snapshot. |
|
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. |
|
403 | Cannot demote the last owner of the organization. |
|
403 | Cannot demote the last owner of the group. |
|
400 | Cannot distribute subnets. There must be at least one subnet available. |
|
403 | Cannot download a log collection request job in the
EXPIRED state. |
|
403 | Cannot download a log collection request job in the
IN_PROGRESS state. |
|
403 | Cannot extend duration of logs that have already expired. |
|
409 | Cannot get backup configuration without cluster being monitored. |
|
500 | Cannot get volume size limits for volume type <type> . |
|
403 | Cannot modify host <host> because it is managed by
Automation. |
|
409 | Cannot modify backup configuration for individual shard; use
cluster ID <ID> for entire cluster. |
|
400 | Cannot remove caller’s IP address <address> from
whitelist. |
|
409 | Username and password cannot be manually set for a managed cluster. |
|
400 | Cluster checkpoint interval can only be set for sharded clusters, not replica sets. |
|
400 | Username and password fields are only supported for
authentication mechanism MONGODB_CR or PLAIN . |
|
400 | Cannot change password unless authentication mechanism is
MONGODB_CR or PLAIN . |
|
400 | Setting the point in time window is not allowed. |
|
400 | Setting the reference point time of day is not allowed. |
|
409 | Cannot start backup unless the cluster is in the INACTIVE
or STOPPED state. |
|
402 | Cannot start backup without providing billing information. |
|
409 | Cannot start restore job for deleted cluster snapshot. |
|
409 | Cannot start restore job for deleted snapshot. |
|
409 | Cannot start restore job for incomplete cluster snapshot. |
|
409 | Cannot stop backup unless the cluster is in the STARTED state. |
|
409 | Cannot terminate backup unless the cluster is in the STOPPED state. |
|
404 | No checkpoint with ID <ID> exists for cluster
<cluster> . |
|
404 | No cluster with ID <ID> exists in group <group> . |
|
404 | No restore job with ID <ID> exists for config server
<config server> . |
|
404 | No snapshot with ID <ID> exists for config server
<config server> . |
|
400 | Metric <metric> requires a database name to be provided. |
|
404 | No database with name <name> exists on host <host> . |
|
400 | The limit check failed while trying to add the requested resource. Please try again. |
|
400 | Failed to send an invitation to <username> to join
<group> . |
|
400 | Metric <metric> requires a device name to be provided. |
|
404 | No device with name <name> exists on host <host> . |
|
400 | The domain name for the machine is too long. Try shortening the hostname prefix. |
|
400 | Two or more of the IP addresses being added to the whitelist are the same. |
|
400 | Email and/or SMS must be enabled for group notifications. |
|
400 | Email and/or SMS must be enabled for user notifications. |
|
400 | Expiration date for log collection request job must be in the future. |
|
400 | Expiration date for log collection request job can only be as far as 6 months in the future. |
|
402 | Cannot close account due to a charge failure. |
|
403 | Feature not supported by current account level. |
|
400 | Timestamp must be whole number of seconds. |
|
400 | The specified event type <type> can only be used for
global alerts. |
|
409 | A group with name <name> already exists. |
|
404 | No group with API Key <key> exists. |
|
400 | The specified group ID <ID> does not match the URL. |
|
404 | No group with name <name> exists. |
|
404 | No group with ID <ID> exists. |
|
404 | No last ping exists for host <host> in group <group> . |
|
404 | No host with ID <ID> exists in group <group> . |
|
404 | No host with hostname and port <name:port> exists in
group <group> . |
|
400 | Instance must be created with exactly one SSH-enabled security group. |
|
400 | An invalid agent type name <name> was specified. |
|
404 | An invalid alert configuration ID <ID> was specified. |
|
404 | An invalid alert ID <ID> was specified. |
|
400 | An invalid alert status <status> was specified. |
|
400 | Invalid attribute <attribute> specified. |
|
400 | Invalid authentication mechanism <mechanism> . |
|
400 | An invalid authentication type name <name> was specified. |
|
404 | An invalid checkpoint ID <ID> was specified. |
|
400 | Cluster checkpoint interval must be 15, 30, or 60 minutes. |
|
404 | An invalid cluster ID <ID> was specified. |
|
400 | Daily snapshot retention period must be between 1 and 365 days. |
|
400 | An invalid directory name <name> was specified. |
|
400 | An invalid email address was specified. |
|
400 | An invalid enumeration value <value> was specified. |
|
400 | Event type <type> not supported for alerts. |
|
400 | Backup configuration cannot specify both included namespaces and excluded namespaces. |
|
400 | Flowdock flow name cannot contain spaces. |
|
400 | An invalid granularity <granularity> was specified. |
|
404 | An invalid group ID <ID> was specified. |
|
400 | Group name cannot contain “10gen-” or “-10gen”. |
|
400 | An invalid group name <name> was specified. |
|
400 | A group tag must be a string (alphanumeric, periods,
underscores, and dashes) of length <MAX_TAG_LENGTH>
characters or less. |
|
400 | Invalid host port <number> . |
|
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. |
|
400 | Invalid hostname <name> . |
|
400 | Invalid instance count <number> . It must be between
<number> and <number> . |
|
400 | Invalid instance type <type> . It must be one of the
listed instance types returned in the machine configuration
options. |
|
400 | The IOPS value <number> is not valid. The maximum ratio
between the IOPS value and the volume size is 30 : 1. |
|
400 | The IOPS value <number> is not valid. It must be between
the minimum and maximum values returned in the machine
configuration options. |
|
404 | An invalid restore job ID <ID> was specified. |
|
400 | Received JSON for the <attribute> attribute does not
match expected format. |
|
400 | Received JSON does not match expected format. |
|
404 | An invalid key ID <ID> was specified. |
|
400 | Log request size must be a positive number. |
|
404 | An invalid machine ID <ID> was specified. |
|
400 | The specified machine image is invalid. |
|
404 | An invalid metric name <name> was specified. |
|
400 | The username <username> is not a valid MongoDB login. |
|
400 | Monthly snapshot retention period must be between 1 and 36 months. |
|
400 | An invalid mount location <location> was specified. The
mount location must be equal to or a parent of
<location> . |
|
400 | Operator <operator> is not compatible with event type
<type> . |
|
400 | An invalid period was specified. |
|
400 | Invalid parameter combination specified for provider
<provider> . |
|
400 | Invalid query parameter <parameter> specified. |
|
400 | Snapshot schedule reference hour must be between 0 and 23, inclusive. |
|
400 | Snapshot schedule reference minute must be between 0 and 59, inclusive. |
|
400 | Snapshot schedule timezone offset must conform to ISO-8601 time offset format, such as “+0000”. |
|
400 | No region <region> exists for provider <provider> . |
|
400 | Role <role> is invalid for group <group> . |
|
400 | Invalid root volume size <number> . It must be between the
minimum and maximum values returned in the machine
configuration options. |
|
400 | Security group <group> is invalid. It must be one of the
security groups returned in the machine configuration
options. |
|
404 | An invalid snapshot ID <ID> was specified. |
|
400 | Snapshot interval must be 6, 8, 12, or 24 hours. |
|
400 | Snapshot retention period must be between 1 and 5 days. |
|
400 | An invalid SSH key was specified. |
|
404 | An invalid user ID <ID> was specified. |
|
400 | The specified username is not a valid email address. |
|
400 | No user <username> exists. |
|
400 | Invalid volume name <name> . It must be one of the listed
volume names returned in the machine configuration options. |
|
400 | Invalid or unavailable VPC <VPC> or subnet <subnet> . |
|
400 | Weekly snapshot retention period must be between 1 and 52 weeks. |
|
404 | An invalid maintenance window ID <ID> was specified. |
|
400 | No zone <zone> exists for region <region> . |
|
403 | IP address <address> is not allowed to access this
resource. |
|
404 | No last ping exists for group <group> . |
|
409 | Cannot set HTTP link expiration time after snapshot deletion time. |
404 | No job with the given ID exists in this group. | |
|
400 | No machine configuration parameters exist for provider
<provider> . |
|
404 | No maintenance window with ID <ID> exists in group
<group> . |
|
400 | Maintenance window configurations must specify a start date before their end date. |
|
400 | Maximum number of users per group (<number> ) in <ID>
exceeded while trying to add users. |
|
400 | Maximum number of users per organization (<number> ) in
<ID> exceeded while trying to add users. |
|
400 | Maximum number of teams per group (<number> ) in <ID>
exceeded while trying to add teams. |
|
400 | Maximum number of Cloud Manager users per team exceeded while trying to add users. Teams are limited to 250 users. |
|
400 | Maximum number of teams per organization exceeded while trying to add team. Organizations are limited to 250 teams. |
|
400 | The metric threshold should only be specific for host metric alerts. |
|
404 | No alert configuration ID was found. |
|
400 | The required attribute <attribute> was not specified. |
|
400 | The attributes <attribute> and <attribute> must be
specified for authentication type <type> . |
|
400 | Authentication mechanism <mechanism> requires username
and password. |
|
400 | Maintenance window configurations must specify at least one alert type. |
|
400 | Maintenance window configurations must specify an end date. |
|
400 | Maintenance window configurations must specify a start date. |
|
400 | A metric threshold must be specified for host metric alerts. |
|
400 | At least one notification must be specified for an alert configuration. |
|
400 | Either the <attribute> attribute or the <attribute>
attribute must be specified. |
|
400 | Either the <attribute> attribute, the <attribute>
attribute, or the <attribute> attribute must be
specified. |
|
400 | The required attribute <attribute> was incorrectly
specified or omitted. |
|
400 | Username cannot be changed without specifying password. |
|
400 | The required query parameter <parameter> was not
specified. |
|
400 | Group notifications cannot specify an empty list of roles. |
|
409 | Changing the storage engine will require a resync, so a sync source must be provided. |
|
400 | A threshold must be specified for member health alerts. |
|
409 | Multiple groups exist with the specified name. |
|
400 | Either the <parameter> query parameter or the
<parameter> query parameter but not both should be
specified. |
|
409 | A suitable checkpoint could not be found for the specified point-in-time restore. |
|
401 | No current user. |
|
403 | The API is not supported for the Free Tier of Cloud Manager. |
|
409 | No group SSH key exists for group <group> . |
|
402 | No payment information was found for group <group> . |
|
400 | Could not retrieve availability zones from <account>
account. |
|
400 | Could not retrieve available instance types from
<account> account. |
|
400 | Could not retrieve security groups from <account>
account. |
|
404 | No SSH keys found in group <group> . |
|
400 | The specified metric requires a nonzero delay for all notifications. |
|
404 | Host <host> is not an SCCC config server. |
|
404 | Metric <metric> is neither a database nor a disk metric. |
|
401 | The currently logged in user does not have the global user administrator. |
|
401 | The currently logged in user does not have the user
administrator role in group <group> . |
|
401 | The current user is not in the group, or the group does not exist. |
|
401 | The currently logged in user does not have the administrator
role in organization <organization> . |
|
400 | Only sharded clusters and replica sets can be patched. |
|
401 | The currently logged in user does not have the user
administrator role for any group, team, or organization
containing user <username> . |
|
400 | Notifications must have an internal of at least 5 minutes. |
|
400 | At least one notification is a type that is only available for global alert configurations. |
|
400 | A log collection request job can only be restarted if it is
in the FAILED state. |
|
404 | No organization with ID <ID> exists. |
|
401 | Account failed to authenticate with <credentials> . |
|
404 | No provider configuration with ID <ID> exists for
provider <provider> . |
|
404 | No provider configuration exists for provider <provider> . |
|
404 | No provider <provider> exists. |
|
404 | Provider <provider> not currently supported. |
|
404 | No provision machine job with ID <ID> exists in group
<group> . |
|
409 | Provisioned machine with ID <ID> could not terminate
because a MongoDB process, Monitoring, or Backup
is currently running on the machine. |
|
404 | No provisioned machine with ID <ID> exists in group
<group> . |
|
500 | Unable to retrieve configuration options from the provider. |
|
429 | Resource <resource> is limited to <number> requests
every <number> minutes. |
|
400 | Rate limit of <number> invitations per <number>
minutes exceeded. |
|
404 | Cannot find resource <resource> . |
|
404 | No restore job with ID <ID> exists in group <group> . |
|
404 | No restore job with ID <ID> exists for cluster
<cluster> . |
|
400 | Group-specific role <role> requires a group ID. |
|
400 | Global role <role> cannot be specified with a group ID. |
|
400 | Role <role> cannot be specified with an organization ID. |
|
400 | Role <role> requires an organization ID. |
|
403 | Roles specified for user. |
|
404 | No snapshot with ID <ID> exists for cluster
<cluster> . |
|
409 | An SSH key with the name <name> already exists. |
|
404 | No SSH key with name <name> exists. |
|
404 | No SSH key with ID <ID> exists. |
|
400 | A threshold should only be present for member health alerts. |
|
400 | At most one group notification can be specified for an alert configuration. |
|
400 | Groups are limited to <MAX_TAGS_PER_GROUP> tags. |
|
400 | Mode TOTAL is no longer supported. |
|
500 | Unexpected error. |
|
400 | Threshold units cannot be converted to metric units. |
|
Automation agent version is less than the accepted minimum version. | |
|
400 | The specified delivery method is not supported. |
|
403 | Operation not supported for current configuration. |
|
403 | Operation not supported for current plan. |
|
400 | Notification type <type> is unsupported. |
|
403 | Setting the backup state to <state> is not supported. |
|
409 | Cluster checkpoint interval not supported by the Backup version; please upgrade. |
|
409 | Excluded namespaces are not supported by this Backup version; please upgrade. |
|
409 | Included namespaces are not supported by this Backup version; please upgrade. |
|
409 | A user with username <username> already exists. |
|
404 | No user with ID <ID> exists. |
|
404 | User <username> is not in group <group> . |
|
401 | Current user is not authorized to perform this action. |
|
404 | No user with username <username> exists. |
|
400 | Volume encryption is not available on instances of type
<type> . |
|
400 | Volume optimization is not available on instances of type
<type> . |
|
400 | The specified password is not strong enough. |
|
400 | Webhook URL must be set in the group before adding webhook notifications. |
|
401 | Cannot access whitelist for user <username> , which is not
currently logged in. |
|
404 | IP address <address> not on whitelist for user
<username> . |