Management API v4.0 Change Log

Flush Bucket Data

This enables you to delete all of the data presently stored in a bucket.

Create Bucket

The flush field is now deprecated and the flushEnabled field is available in the Create Bucket endpoint.

Enable or Disable App Service Audit Logging
Get App Service Audit Log State
List App Endpoint Audit Log Event IDs
Update App Endpoint Audit Logging Config
Get App Endpoint Audit Logging Config
Configure App Service Audit Log Streaming
Start or Resume Audit Log Streaming
Get App Service Audit Log Streaming State
Initiate Audit Log Export
List Audit Log Export Jobs
Get Audit Log Export Job

Added the App Services Audit Logging API. This enables you to configure and retrieve audit logs for App Services. For details, see Audit Logging.

Create Cluster

The enablePrivateDNSResolution field in the Create Cluster endpoint is conditionally available. The option to create a cluster with restricted public access is available only on request. For more information, contact Couchbase Support.

List Key Rotation History

This enables you to retrieve a list with the complete history of rotations for a specific customer-managed encryption key within the organization.

Create Network Peering
List Network Peering Records
Get Network Peering record
Get Azure VNET Peering CLI Command

Added the Network Peering API for Azure. This enables you to configure a secure private network connection from Couchbase Capella clusters hosted with Azure to your application’s VPC.

Get Private Endpoint Service Status
Enable Private Endpoint Service
Disable Private Endpoint Service
List Private Endpoints
Get Private Endpoint CLI Command
Accept Private Endpoint Request
Reject or disassociate Private Endpoint

Added the Private Endpoint Service API. This enables you to access your Capella cluster from your cloud provider’s private network.

Create Cluster

The configurationType field in the Create Cluster endpoint is now deprecated.

List Events
Get Event
List Events
Get Project Event

Added the System Events API. This enables you to retrieve the sequence of events and actions performed by users within the Capella environment. This is available at an organization and project level.

Create Network Peering
List Network Peering Records
Get Network Peering record
Delete Network Peering

Added the Network Peering API for AWS and GCP. This enables you to configure a secure private network connection from Couchbase Capella clusters hosted with AWS and GCP to your application’s VPC.

Create Cluster Audit Log Export job

The Create Cluster Audit Log job API now supports the following RBAC roles: Project Viewer, Cluster Data Reader/Writer, and Cluster Data Reader.

Migrate Buckets

Added the Migrate Buckets API. For clusters using Couchbase Server 7.6 or later, this enables you to migrate from Couchstore to Magma storage engines.

Update Organization Configuration

Organization owners can now add, update, and delete custom subdomains for AWS clusters. Reach out to Couchbase support to enable this feature.

Update Username

Temporarily removed the operation to update a user name.

Update Cluster Audit Log Configuration
Get Cluster Audit Log Configuration
List Filterable Audit Log Events
Create Cluster Audit Log Export Job
List Cluster Audit Log Export Jobs
Get Cluster Audit Log Export

Added the Audit Log API. This enables you to configure auditing on your Capella cluster, and export audit logs to an AWS S3 bucket.

Update Collection
Create Alert Integration
List Alert Integrations
Get Alert Integration
Update Alert Integration
Delete Alert Integration
Test Alert Integration

Added the Alert Integration API. This enables you to send Capella alert notifications to common services, such as ServiceNow.

Create Cluster On/Off schedule
Get Cluster On/Off schedule
Update Cluster On/Off schedule
Delete Cluster On/Off schedule

You can schedule when your provisioned cluster turns on or off to save costs. Turning off your cluster turns off the compute for your cluster, but the storage remains.

Create Cluster
List Clusters
Get Cluster
Update Cluster

For clusters deployed on Microsoft Azure, you can now enable disk auto-expansion for each service group in the cluster. When enabled, the disk storage for each node in the service group automatically expands if needed.

Create Key Metadata
List Key Metadata
Get Key Metadata
Rotate Key
Delete Key Metadata
Associate Key with Cluster
Disassociate Key from Cluster

Added the Customer Managed Encryption Keys API. This enables you to manage encryption keys.

Get Scope
Delete Scope
List Scopes
Create Scope
Get Collection
Delete Collection
List Collections
Create Collection

Added Scopes and Collections operations to the Buckets API. These enable you to manage scopes and collections.

In addition, to reflect this change, the Buckets API has been renamed as the Buckets, Scopes and Collections API.

Load Sample Data
List Sample Data Import Buckets
Get Sample Import Bucket
Delete Sample Import Bucket

Added the Import Sample Dataset API. This enables you to import Couchbase sample data sets into the Capella cluster: travel-sample, beer-sample, and so on. You can also list sample data sets, get details of a sample data set, or delete a sample data set.

Update Username

Organization owners can now update user names for any user in the organization.

Create Cluster

The CIDR block for the cloud provider is no longer required when creating a cluster. If you do not provide a CIDR block when creating a cluster, a valid unused CIDR block is generated automatically.

Get Cluster

Getting details of a cluster now returns the connection string — that is, the cluster endpoint for the client connection.

Create Cluster Credentials

Documentation for the request body now describes restrictions on the cluster credential name and the associated password.

Update Project
Update Cluster
Update App Service Specs

Clarified examples to show that the If-Match request header should not include a custom prefix, but must match the ETag returned by the GET operation.

Update User

Corrected responses to show that the ETag is not returned for this operation.

List API Keys
List Projects
List Clusters
List Users
List Allowed CIDRs
List Cluster Credentials
List App Services

Documentation now lists valid values for the sortBy field for each endpoint.