Cloud Manager Administration API Error Codes
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
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 Cloud Manager Administration API, Cloud Manager returns one of the following error codes:
Error | HTTP Code | Description |
|---|---|---|
Group has an unpaid invoice that is more than 30 days old. | ||
Acknowledgement comment too long. It must not exceed
| ||
The address | ||
No alert configuration with ID | ||
No alert with ID | ||
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 itself or by a user administrator. | ||
The specified IP address does not exist in the corresponding API Key access list. | ||
The attribute | ||
The attribute | ||
The attribute | ||
Authentication mechanism | ||
No automation configuration exists for group | ||
No backup configuration exists for cluster | ||
User | ||
No user with username | ||
Should not specify both the IP address and the CIDR block. | ||
The specified username | ||
The specified address cannot be added to access list.
Cloud Manager does not allow certain IP addresses to be
added to the access list, such as | ||
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. | ||
You cannot remove all roles from a user. Specify at least one role. | ||
Cannot demote the last owner of the organization. | ||
Cannot demote the last owner of the group. | ||
Cannot distribute subnets. There must be at least one subnet available. | ||
Cannot download a log collection request job in the
| ||
Cannot download a log collection request job in the
| ||
Cannot extend duration of logs that have already expired. | ||
Cannot get backup configuration without cluster being monitored. | ||
Cannot get volume size limits for volume type | ||
Cannot modify host | ||
Cannot modify backup configuration for individual shard; use
cluster ID | ||
Cannot remove caller's IP address | ||
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 | ||
Cannot change password unless authentication mechanism is
| ||
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 | ||
Cannot start backup without providing billing information. | ||
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 | ||
No cluster with ID | ||
No restore job with ID | ||
No snapshot with ID | ||
Metric | ||
No database with name | ||
The limit check failed while trying to add the requested resource. Please try again. | ||
Failed to send an invitation to | ||
Metric | ||
No device with name | ||
The domain name for the machine is too long. Try shortening the hostname prefix. | ||
Two or more of the IP addresses being added to the access list are the same. | ||
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. | ||
Cannot close account due to a charge failure. | ||
Feature not supported by current account level. | ||
Timestamp must be whole number of seconds. | ||
The specified event type | ||
A group with name | ||
No group with API Key | ||
The specified group ID | ||
No group with name | ||
No group with ID | ||
No last ping exists for host | ||
No host with ID | ||
No host with hostname and port | ||
Instance must be created with exactly one SSH-enabled security group. | ||
An invalid agent type name | ||
An invalid alert configuration ID | ||
An invalid alert ID | ||
An invalid alert status | ||
Invalid attribute | ||
Invalid authentication mechanism | ||
An invalid authentication type name | ||
An invalid checkpoint ID | ||
Cluster checkpoint interval must be 15, 30, or 60 minutes. | ||
An invalid cluster ID | ||
Daily snapshot retention period must be between 1 and 365 days. | ||
An invalid directory name | ||
An invalid email address was specified. | ||
An invalid enumeration value | ||
Event type | ||
Backup configuration cannot specify both included namespaces and excluded namespaces. | ||
An invalid granularity | ||
An invalid group ID | ||
Group name cannot contain "10gen-" or "-10gen". | ||
An invalid group name | ||
A group tag must be a string (alphanumeric, periods,
underscores, and dashes) of length | ||
Invalid host port | ||
Invalid hostname prefix | ||
Invalid hostname | ||
Invalid instance count | ||
Invalid instance type | ||
The IOPS value | ||
The IOPS value | ||
An invalid restore job ID | ||
Received JSON for the | ||
Received JSON does not match expected format. | ||
An invalid key ID | ||
Log request size must be a positive number. | ||
An invalid machine ID | ||
The specified machine image is invalid. | ||
An invalid metric name | ||
The username | ||
Monthly snapshot retention period must be between 1 and 36 months. | ||
An invalid mount location | ||
Operator | ||
An invalid period was specified. | ||
Invalid parameter combination specified for provider
| ||
Invalid query parameter | ||
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". | ||
No region | ||
Role | ||
Invalid root volume size | ||
Security group | ||
An invalid snapshot ID | ||
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 | ||
The specified username is not a valid email address. | ||
No user | ||
Invalid volume name | ||
Invalid or unavailable VPC | ||
Weekly snapshot retention period must be between 1 and 52 weeks. | ||
An invalid maintenance window ID | ||
No zone | ||
IP address | ||
No last ping exists for group | ||
Cannot set HTTP link expiration time after snapshot deletion time. | ||
No job with the given ID exists in this group. | ||
No machine configuration parameters exist for provider
| ||
No maintenance window with ID | ||
Maintenance window configurations must specify a start date before their end date. | ||
Maximum number of users per group ( | ||
Maximum number of users per organization ( | ||
Maximum number of teams per group ( | ||
Maximum number of Cloud 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 | ||
The attributes | ||
Authentication mechanism | ||
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 | ||
Either the | ||
The required attribute | ||
Username cannot be changed without specifying password. | ||
The required query parameter | ||
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 | ||
A suitable checkpoint could not be found for the specified point-in-time restore. | ||
No current user. | ||
The API is not supported for the Free Tier of Cloud Manager. | ||
No group SSH key exists for group | ||
No payment information was found for group | ||
Could not retrieve availability zones from | ||
Could not retrieve available instance types from
| ||
Could not retrieve security groups from | ||
No SSH keys found in group | ||
The specified metric requires a nonzero delay for all notifications. | ||
Host | ||
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 | ||
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 | ||
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 | ||
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 | ||
No organization with ID | ||
Account failed to authenticate with | ||
No provider configuration with ID | ||
No provider configuration exists for provider | ||
No provider | ||
Provider | ||
No provision machine job with ID | ||
Provisioned machine with ID | ||
No provisioned machine with ID | ||
Unable to retrieve configuration options from the provider. | ||
Resource | ||
Rate limit of | ||
Cannot find resource | ||
No restore job with ID | ||
No restore job with ID | ||
Group-specific role | ||
Global role | ||
Role | ||
Role | ||
Roles specified for user. | ||
No snapshot with ID | ||
An SSH key with the name | ||
No SSH key with name | ||
No SSH key with ID | ||
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 | ||
Mode | ||
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 | ||
Setting the backup state to | ||
Cluster checkpoint interval not supported by the 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 | ||
No user with ID | ||
User | ||
Current user is not authorized to perform this action. | ||
No user with username | ||
Volume encryption is not available on instances of type
| ||
Volume optimization is not available on instances of type
| ||
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 | ||
IP address |