Management API v4.0 Errors

1000

BadRequest

The server cannot or will not process the request due to something that is perceived to be a client error.

Check if you have provided a valid URL and all the required params are present in the request body.

1000

BadRequestWithMessage

The request was malformed or invalid.

6004

InvalidBucketConflictResolution

The provided conflict resolution is not supported. Please choose a valid conflict resolution strategy for the bucket.

5001

JobActionEmpty

Invalid job configuration. Action field cannot be empty, and must be one of 'backup' or 'restore'.

Returned when a job is attempting to be added to a backup schedule with no action.

5002

JobSourceEmpty

Invalid job configuration. Source field cannot be empty, and must be one of 'manual' or 'scheduled'.

Returned when a job is attempting to be added to a backup schedule with no source.

5003

NilRestoreJobOptions

Invalid job configuration. All restore jobs must have restore options set.

Returned when a restore job is being added without restore options set.

5008

InvalidTimingDay

The day attribute is invalid. Only an integer between 0 and 6 is allowed.

Returned when the day attribute to the timing struct is not an integer between 0 and 6.

5009

InvalidTimingHour

The hour attribute is invalid. Only an integer between 0 and 23 is allowed.

Returned when the hour attribute to the timing struct is not an integer between 0 and 23.

5011

InvalidIntervalValue

The incrementalEvery attribute is invalid.

Returned when asked to create or modify a backup schedule, but the incremental value provided is not valid. Must be one of '1', '2', '4', '6', '8', '12', or '24'.

5012

InvalidIntervalUnit

The unit attribute is invalid. Must be one of 'minute', 'hourly', 'daily', or 'weekly'.

Returned when the unit attribute is not one of the expected allowed constants.

5013

InvalidFullIntervalUnit

Unsupported type for backup schedule. The full backup type must be 'weekly'.

Returned when the scheduled backup type is not 'weekly'.

5014

InvalidIncrementalIntervalMinimum

Invalid incremental backup interval. The minimum allowed incremental backup interval is every 4 hours.

Returned when the incremental backup interval is quicker than every 4 hours.

5015

InvalidBackupRetentionTime

The backup retention time is invalid.

Returned when the given backup retention time is not supported.

1001

Unauthorized

The request is unauthorized. Please ensure you have provided appropriate credentials in the request header. Please make sure the client IP that is trying to access the resource using the API key is in the API key allowlist.

1002

AccessDenied

Access Denied.

Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource.

1002

RBACAccessDenied

Access Denied.

Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource.

2001

ProjectCountQuotaReached

Unable to create a project. Project count limit is reached.

Please ensure to stay within the quota. If required, please create support ticket in order to increase the quota.

2000

ProjectNotFound

The server cannot find a project by its ID.

Check if the project ID is valid.

2002

ProjectsNotFoundWithMessage

Check if the project ID is valid.

3000

NotFound

Please ensure that the organization ID is correct.

4025

ClusterNotFound

The requested cluster details could not be found or fetched. Please ensure that the correct cluster ID is provided.

4026

V3ClusterNetworkInfoNotFound

The cluster network information for the received ID could not be found. Please ensure that the correct ID is provided.

6008

BucketNotFound

The requested bucket does not exist. Please ensure that the correct bucket ID is provided.

5017

BackupRecordNotFound

The requested backup record could not be found.

Returned when the requested backup record could not be found.

5019

ExportRecordNotFound

The requested download record could not be found.

Returned when the download record cannot be found for the given ID and cluster.

5023

UnableToRetrieveBackup

Unable to retrieve the backup specified.

Returned when encountering an error while attempting to retrieve a backup record.

5029

BackupScheduleNotFound

Backup schedule not found.

Returned when a backup schedule is not found for the bucket.

8000

UserNotFound

Check userId is valid.

8013

DeleteUserNotFound

Verify the provided user ID and ensure it corresponds to an existing user before attempting to delete.

8018

UserWithIDNotFound

User not found. The system was unable to locate a user with the specified ID.

Ensure that the provided user ID is correct and corresponds to an existing user.

12000

ErrBYOKMetadataNotFound

Unable to process request for key. The key requested does not exist. Please ensure the ID of the key is correct and try again.

Please double-check the provided ID for the key and ensure it exists before making the request.

11001

CollectionNotFound

The requested collection details could not be found or fetched. Please ensure that the correct collection name is provided.

11002

ScopeNotFound

The requested scope details could not be found or fetched. Please ensure that the correct scope name is provided.

11040

OnOffScheduleNotFound

Returned from the API when a database does not have an existing On/Off schedule.

1010

Conflict

There is a conflict with the current state of a resource.

Returned when trying to create or update a resource that already exists or has conflicting information.

6027

BucketDeletionNotAllowedWithUnHealthySyncGateway

Cannot delete bucket as associated app service is not in healthy state. Please wait for the app service to become healthy before performing the action.

5000

JobAlreadyExists

Unable to add job, as it already exists and is waiting to be processed.

Returned when there is already a backup or restore job with the same key in the backup config schedule.

5018

BackupScheduleAlreadyExists

Unable to add backup schedule, as a schedule already exists for the bucket.

Returned when there is already a backup schedule for the bucket in the backup config schedule.

5031

BackupIDConflict

Unable to process request, as backup ID in the payload does not match backup ID in the path.

Returned when asked to restore a backup and backup IDs in path and payload do not match.

11018

AppServiceInInvalidStateToBeTurnedOn

Returned from the API when an app service cannot be turned on because it is not currently turned off.

11019

AppServiceInInvalidStateToBeTurnedOff

Returned from the API when an app service cannot be turned off because it's in an unhealthy state.

7010

ClusterInInvalidStateToBeTurnedOn

Returned from the API when a database cannot be turned on because it is not currently turned off.

7011

ClusterInInvalidStateToBeTurnedOff

Returned from the API when a database cannot be turned off because it's in an unhealthy state.

7013

ClusterHasUpcomingMaintenance

Returned from the API when a database cannot be turned off because of upcoming maintenance.

7014

ClusterHasActiveBackupJob

Returned from the API when a database cannot be turned off because of an active backup or restore job.

7015

ClusterHasEphemeralBuckets

Returned from the API when trying to turn off a database with memory only buckets.

7016

ClusterHasPendingRedeployment

Returned from API when given database cannot be turned off because it has a pending redeployment.

9000

ErrEtagVersionConflict

Please include the correct ETag version with the request.

9001

ErrInvalidETagVersion

The ETag provided is not valid. The version of the document provided does not appear to be an integer.

Please include the correct ETag version with the request.

9002

ErrInvalidETag

The ETag provided is not valid.

Please include the correct ETag version with the request.

9003

ErrEtagVersionConflictInPatchUser

Please retry the request.

1004

UnprocessableEntityWithMessage

The request was malformed or invalid.

2003

ProjectDescriptionTooLong

Retry with a description with a maximum length 256 characters.

2004

ProjectNameTooLong

Retry with a name with a maximum length 128 characters.

4000

ErrClusterNoAZType

Please ensure that Availability Zone type is provided.

4001

ErrProviderNotSupported

Please ensure that the provider provided is supported.

4002

NilSupportPackage

Please ensure that payload or body of the request is not empty.

4003

TimezoneInvalid

Please ensure that a valid timezone is provided.

4004

ErrClusterSpecCountRequired

Please ensure that server group has at least (1) node.

4005

ErrClusterSpecNoServices

Please ensure that server specifications provided contain services.

4008

ErrClusterInvalidCIDR

Please ensure that the provided CIDR is valid.

4009

ErrClusterInvalidCIDRNotNetworkAddress

Please ensure that CIDR range has an IP address of the network address.

4010

ErrClusterInvalidCIDRNotInPrivateRange

Please ensure that the CIDR range is within the private ID address ranges.

4011

ClusterNameTooShort

Please ensure that the provided name has at least the minimum length.

4012

ClusterNameTooLong

Please ensure that the provided cluster name does not exceed the maximum length limit.

4013

ClusterNameInvalidCharacter

Please ensure that the cluster name only contains valid characters when creating or modifying the cluster name.

4014

ClusterDescriptionTooLong

Please ensure that the provided cluster description does not exceed the maximum length limit when creating or modifying the cluster.

4016

ErrRegionNotSupported

Please ensure that the provided region is supported by the given cloud provider.

4017

ErrClusterSpecsDataRequired

Please include the data service in the cluster specifications when creating or modifying the cluster.

4018

ErrClusterCreateProjectInvalid

Please provide a valid project ID when creating a new cluster. The provided project does not exist.

4019

ErrClusterCreateTenantInvalid

Please provide a valid tenant ID when creating a new cluster. The provided tenant does not exist.

4020

ErrClusterInvalidImageName

Please provide a valid image name when performing an operation on the cluster. The provided image name is not valid.

4021

ErrClusterInvalidPackageType

Please provide a valid package type when creating or modifying a cluster. The provided package type is not valid.

4022

ErrClusterInvalidProvider

Please provide a supported provider when creating a cluster. The provided provider is not supported.

4023

ErrClusterSpecInvalidCompute

Please provide a valid instance type when creating or modifying a cluster's specifications. The provided compute type is invalid.

4024

ErrClusterInvalidActivation

The tenant is not able to create a new cluster due to payment issues or revoked activation.

4027

ErrInvalidClusterArchitecture

The requested action is not supported for the cluster's architecture. Please ensure the cluster architecture supports the action.

4028

ErrDiskIopsSpecified

Please do not specify IOPS for this disk type when attempting to deploy a cluster.

4029

ErrDiskSizeAndIopsSpecified

Please do not specify disk size or IOPS for this disk type when attempting to deploy a cluster.

4030

ErrCBVersionNotSupported

Please provide a valid Couchbase Server version when creating a cluster. The provided server version is not supported.

4031

ErrClusterMismatchProjectId

Please provide a valid projectId.

4032

ErrInvalidAllowListExpiry

Please check the expiry for the allowlist.

4033

ErrClusterAuditLogExportRequestStartTooFarInPast

Please specify start time less than 30 days ago.

4034

ErrClusterAuditLogExportRequestStartNotFarEnoughInPast

Please specify start time more than 15 minutes ago.

4035

ErrClusterAuditLogExportRequestEndBeforeStart

Please ensure start time is before end time.

4036

ErrClusterAuditLogExportRequestTimeRangeTooShort

Please specify time range that is more than 15 minutes.

5000

PaginationQueryParamInvalidSortDirection

Please provide a valid sort direction ('asc' or 'desc') when using the 'sortDirection' parameter for pagination in the request.

5001

PaginationSortByFieldNotSupported

Please provide a valid sort by field when using the 'sortBy' parameter for pagination in the request.

6000

BucketMaxBucketsExceeded

The maximum number of buckets has already been reached. Unable to create a new bucket.

6001

BucketNameExists

The bucket name provided already exists. Please choose a different name for the bucket.

6002

BucketMemoryTooBig

The requested bucket size exceeds the maximum allowed size. Please choose a smaller size for the bucket.

6003

MagmaBucketInvalidCBVersion

When creating a bucket with the Magma storage engine, please ensure that the Couchbase Server version is at least 7.1.

6005

InvalidDurabilityLevel

The provided durability level is not supported. The supported levels are 'none', 'majority', 'persistToMajority', and 'majorityAndPersistActive'. Please choose a valid durability level for the bucket.

6006

BucketTooManyReplicasForCluster

The requested number of replicas exceeds the maximum allowed replicas based on the cluster configuration. Please reduce the number of replicas for the bucket.

6007

BucketClusterNotFound

The associated cluster for the bucket could not be located. Please ensure that the cluster exists and try again.

6006

ErrClusterUnsupportedArchitecture

The requested action or configuration change is not supported for the cluster's architecture. Please ensure the cluster has a supported architecture.

6009

ErrClusterArchitectureUnknown

The architecture of the cluster could not be determined.

6010

EphemeralBucketsNotSupported

Memory Only (ephemeral) buckets are not currently enabled.

6011

BucketNameEmpty

The bucket name is not valid. A bucket name cannot be empty. Please provide a valid name for the bucket.

6012

BucketNameDotStart

The bucket name provided is not valid. A bucket name cannot start with a dot ('.'). Please provide a valid name for the bucket.

6013

BucketNameTooLong

The bucket name provided is not valid. The maximum length of the bucket name can be 100 characters. Please provide a valid name for the bucket within the allowed length.

6014

BucketNameInvalidCharacter

The bucket name contains an invalid character. Supported characters are those in the ranges of A-Z, a-z, and 0-9; plus the underscore, period, dash, and percent characters. Please provide a valid name for the bucket.

6015

BucketTypeRequired

Bucket type is required when creating a bucket, and must be one of 'couchbase' or 'ephemeral'. Please specify a valid bucket type for the bucket.

6016

InvalidBucketType

The provided bucket type is invalid. Bucket type must be one of 'couchbase' or 'ephemeral'. Please provide a valid bucket type for the bucket.

6017

EphemeralBucketInvalidStorageBackend

storageBackend is an invalid configuration option for Memory Only buckets. Either switch to a Memory and Disk bucket or remove the 'storageBackend' payload from the request.

6018

EphemeralBucketEvictionPolicyRequired

evictionPolicy is required for Memory Only buckets and must be one of 'nruEviction' or 'noEviction'. Please specify a valid eviction policy for the Memory Only bucket.

6019

EphemeralBucketInvalidEvictionPolicy

The provided evictionPolicy is invalid for Memory Only buckets. evictionPolicy must be one of 'noEviction' or 'nruEviction'. Please provide a valid eviction policy for the Memory Only bucket.

6020

EphemeralBucketInvalidDurabilityLevel

The provided durabilityLevel is invalid for Memory Only buckets. Valid options are none and majority. Please provide a valid durability level for the Memory Only bucket.

6021

CouchbaseBucketInvalidEvictionPolicy

The provided evictionPolicy is an invalid configuration option for Couchbase (Memory and Disk) buckets. Please specify 'fullEviction', or remove the evictionPolicy payload from the request to use the default ('fullEviction').

6022

MagmaBucketSizeTooSmall

Cannot create Magma bucket. The requested size of the Magma bucket is less than the minimum amount of 1024MB. Please choose a larger size for the Magma bucket.

6023

BucketSizeTooSmall

Cannot create bucket. The requested size of the bucket is less than the minimum amount of 100MB. Please choose a larger size for the bucket.

6024

BucketTooManyReplicas

The replica count provided for the bucket is not valid. The maximum number of replicas is 3. Please reduce the number of replicas for the bucket.

6025

MaxTTLTooLarge

The TTL given is too large. The maximum allowed TTL is 2147483647 seconds. Please choose a smaller TTL for the bucket.

6026

BucketTooFewReplicas

The replica count provided for the bucket is not valid. The minimum number of replicas is 0. Please increase the number of replicas for the bucket.

7000

EntityNotWritable

Cannot perform the action due to the entity not being in a writable state. Please wait for the entity to become writable before performing the action.

5016

BackupConfigNotFound

Unable to process request. The backup configuration for the cluster is missing. Please submit a support request to resolve this issue.

Returned when an operation against a backup config is requested and the backup config is missing.

5020

InvalidDateRange

The end date of the range cannot be before the start date of the range.

Returned when an end date that is before the start date of a date range is given.

5021

CloudProviderMismatch

Unable to restore to target cluster, as it is on a different cloud provider than the source.

Returned when attempting to restore from a cluster in one provider to a cluster in another.

5022

TargetClusterNotHealthy

Unable to target a restore for a cluster that is not in a healthy state.

Returned when attempting to create a restore job for an unhealthy cluster.

5024

BackupNotReady

Backups must be in a state of 'ready' before being used.

Returned when attempting to use a backup that is not in a 'ready' state.

5025

BackupHasExpired

Backup must not have expired to be used for a restore.

Returned when attempting to restore a backup that has been expired.

5026

InvalidRestoreSource

The source cluster ID is invalid. Please ensure the source cluster id matches the id in the path.

Returned when attempting to restore a backup and the source cluster id does not match the cluster id in the url path of the request.

5027

RestoreOptionsEmptyServices

Invalid restore options. Services list cannot be empty.

Returned when a restore options services list is empty.

5027

RestoreOptionsUnknownCouchbaseService

Invalid restore options. Unknown service '{{Service}}'.

Returned when a restore options services list contains an unknown service.

5028

CycleHasExpired

Cycle must not have expired to be used for listing backups.

Returned from API when a cycle has been found to be expired.

5030

BackupPending

Unable to process request for backup. Backup in pending state cannot be modified.

Returned when asked to modify or delete a backup in pending state.

8001

ValidationEmailDomain

Check email domain is valid.

8002

BlockedDomainErr

Email accounts using this domain is not accepted.

8003

ValidationEmailError

Validation failed for the email address.

8004

ValidationEmailEmptyString

Email address cannot be empty. Please provide a valid email.

Ensure that you provide a non-empty email address.

8005

ValidationEmailAt

The provided email address email is invalid; the '@' is missing.

Make sure the email address contains the '@' symbol.

8006

ValidationEmailLocalLength

Ensure that the local part of the email address does not exceed 64 characters.

8007

ValidationEmailDomainLength

Check that the domain part of the email address is valid.

8008

ValidationEmailValidString

Ensure that the email address is a valid UTF-8 string.

8010

ErrDuplicateEmail

Sign in with the provided email address or use a different one.

8012

DeleteUserLastOrgOwner

Ensure there is at least one other Organization Owner before attempting to remove this user.

8019

ErrUpdatingRBACForSSOUSer

RBAC permissions for SSO user cannot be updated.

Any RBAC permission changes for an SSO user should be done through a Team except when group mapping is disabled on the Realm.

8020

InvalidStorageBackendOption

Returned when attempting to create a couchstore bucket and providing an invalid storageBackend value. Use either 'couchstore' or 'magma'.

8021

InvalidTimeToLiveValue

The time-to-live value provided is not supported. It should be a non-negative integer.

Returned when a time-to-live unit that is not supported is given during bucket creation. This should be a non-negative value.

8022

ErrCreateDataplaneUserRoleDoesNotExist

Returned when a trying to set a privilege other than data_reader / read or data_writer / write while creating a database credential.

11000

BackendInInvalidStateToBeUpdated

Verify the provided appservice is in healthy state before updating.

12001

ErrBYOKInvalidARN

Please double-check the provided ARN and ensure it follows the correct format

12002

ErrBYOKInvalidKeyName

Please double-check the provided key name and ensure it is valid according to GCP's naming conventions.

12003

ErrBYOKMissingConfigs

Please ensure that the configuration for the key includes metadata for either the AWS or GCP key, and then try again.

12004

ErrBYOKCreateMissingTenant

Please provide a valid tenant ID when creating a CMEK, and ensure that it is included in the request.

12005

ErrBYOKCanNotDelete

Please ensure that the key is not in use by any nodes in your clusters before attempting to delete it.

11003

InvalidMaxTTL

The time-to-live value provided is not supported. It should be a non-negative integer.

Returned when a time-to-live unit given during collection creation is not supported. This should be a non-negative value.

11003

ScopeNameTooLong

The scope name provided is not valid. The maximum length of the scope name can be (251) characters.

Returned if when attempting to create a scope the name of the scope provided is too long.

11004

ScopeNameEmpty

The scope name is not valid. A scope name can not be empty.

Returned if when attempting to create a scope the name of the scope is empty.

11005

ScopeNameInvalidCharacter

Returned if when attempting to create a scope the name of the scope contains an unsupported character.

11006

ScopeNameInvalidStart

The scope name provided is not valid. A scope name can not start with an underscore or percentage.

Returned if when attempting to create a scope the name of the scope provided starts with an underscore or percentage.

11007

ScopeNameExists

Returned if when attempting to create a scope but the name of the scope already exists.

11008

CollectionNameTooLong

The collection name provided is not valid. The maximum length of the collection name can be (251) characters.

Returned if when attempting to create a collection the name of the collection provided is too long.

11009

CollectionNameEmpty

The collection name is not valid. A collection name can not be empty.

Returned if when attempting to create a collection the name of the collection is empty

11010

CollectionNameInvalidCharacter

Returned if when attempting to create a collection the name of the collection contains an unsupported character.

11011

CollectionNameInvalidStart

The collection name provided is not valid. A collection name can not start with an underscore or percentage.

Returned if when attempting to create a collection the name of the collection provided starts with an underscore or percentage.

11012

CollectionNameExists

Returned if when attempting to create a collection but the name of the collection already exists.

11041

ErrInvalidScheduleTimezone

Returned when the timezone in the schedule is invalid.

11042

ErrInvalidNumOfDays

Returned when the provided schedule is missing weekdays.

11043

ErrOnOffDayHasOnTimeBoundary

Returned when the provided schedule has 'on' or 'off' day with 'on' time boundary.

11044

ErrCustomDayNoFromOnTimeBoundary

Returned when the provided schedule has a 'custom' day without 'from' time boundary.

11045

ErrCustomDayInvalidHour

Returned when the provided schedule has a 'custom' day with an invalid hour value.

11046

ErrCustomDayInvalidMinute

Returned when the provided schedule has a 'custom' day with an invalid minute value.

11047

ErrFromBoundaryAfterToBoundary

Returned when the provided schedule has a 'custom' day with 'from' boundary after 'to' boundary.

11048

ErrDayHasInvalidState

Returned when the provided schedule has Custom days with an invalid state.

11049

ErrWeekDaysInvalidOrder

Returned when the provided schedule has the days in an invalid order than the one specified.

11050

ErrInvalidDayName

Returned when the provided schedule has an invalid day name.

11050

OnOffScheduleAlreadyExists

Returned when trying to create a new on/off schedule for the cluster which already exists.

11013

CollectionMaxTTLTooLarge

Returned when the TTL given during collection creation or modification is not valid.

11014

CollectionInvalidServerVersion

Returned when attempting to modify a collection but the server version is not supported. This operation is only supported for server version 7.6.0 and above.

11015

InvalidMaxTTLValue

Returned when a time to live unit that is not supported is given during collection creation or modification.

12000

ErrKMSKeyUsedAsymmetricKey

Returned when attempting to create a CMEK with an asymmetric KMS key. Please provide the ARN of a symmetric KMS key.

13000

ErrAlertIntegrationNotSupportedForTrialUsers

Adding a third party alert notification requires a paid plan. Upgrade to a Capella paid plan to configure an alert integration

Returned when a trial account user tries to use the Alert Integration feature.

1004

APIKeyRateLimitExceeded

Oops! You've made too many requests. Please wait for time specified in the retryAfter header before trying again.

The number of requests allowed per API key has exceeded. Please retry after time specified in the retryAfter header has passed.

10000

InternalServerError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10001

InternalServerErrorWithMessage

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10002

DeleteUserGetStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10003

CognitoDeleteUser

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10004

DeleteUserSessionsStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10005

DeleteUserStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10006

NewUserCreateStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.