Create AI Workflow

Use this operation to enable private networking for your AWS Bedrock model connected to your Workflow. For more information about Workflows, see Process Your Data For the Couchbase AI Data Plane.

List MCP Servers
Create MCP Server
Get MCP Server
Delete MCP Server
Get MCP Server Client Config

Added the MCP Servers API. This enables you to create and manage MCP servers that expose a Capella operational cluster to AI agents over the Model Context Protocol (MCP).

List MCP Tools

Added the MCP Tools API. This enables you to list the tools an MCP server can serve, grouped by tool group.

List Agent Memory Servers
Create Agent Memory Server
Get Agent Memory Server
Delete Agent Memory Server
Copy Agent Memory Server
Get Agent Memory Server Deployment Options
List Organization Agent Memory Servers
List Agent Memory Server Eligible Clusters

Added the AI Agent Memory Servers API. Use this API to deploy and manage Agent Memory servers for your Capella operational clusters. For more information about Agent Memory, see Agent Memory for Persistent Memory Storage.

List Agent Memory API Keys
Create Agent Memory API Key
Get Agent Memory API Key
Delete Agent Memory API Key
List Organization Agent Memory API Keys

Added the AI Agent Memory API Keys API. Use this API to create and manage the API keys that authenticate calls to the Agent Memory API. For more information about Agent Memory API keys, see Agent Memory API Keys.

List Agent Memory Server Allowed CIDRs
Create Agent Memory Server Allowed CIDR
Delete Agent Memory Server Allowed CIDR
List Organization Agent Memory Allowed CIDRs

Added the AI Agent Memory Allowed CIDRs API. Use this API to manage the IP addresses that can access your Agent Memory servers. For more information about allowed IP addresses, see Allowed IP Addresses.

List Capella Privileges
List Database Roles
Create Database Role
Get Database Role
Update Database Role
Delete Database Role

Added the Database Roles API. Use this API to manage access roles for advanced access credentials. For more information about access roles, see Advanced Access Credentials. For more information about managing cluster access, see Manage Cluster Access Credentials.

Get Eventing Function Code
Update Eventing Function Code
Get Eventing Function
Delete Eventing Function
Update Eventing Function
Create Eventing Function
List Eventing Functions
Set Eventing Function State
Get Function Logs

Added the Eventing Functions API. Use this API to run JavaScript code in response to data changes in a collection. For more information about Eventing Functions, see Run a Function on Data Change.

Create Alert Integration
List Alert Integrations
List Channels for an Alert Integration
Get Alert Integration
Update Alert Integration
Delete Alert Integration
Test Alert Integration

Updated the Alert Integration API to also support Slack and Microsoft Teams as third-party tools for alert integrations in Capella. For more information about alert integrations, see Alert Integrations.

Create AI Workflow
Get Supported External Embedding Models

The AI Workflows API now supports AWS Bedrock as an external embedding model provider.

Update Deletion Protection

Use this operation to enable or disable deletion protection for a cluster. For example, when you enable deletion protection, you cannot delete your cluster, its App Services, and buckets, and you cannot flush bucket data.

Get Categorized Billing
Get Itemized Billing Per Cluster
Get Prepaid Credits Billing
Get Pay As You Go Billing
Download Categorized Billing
Download Itemized Billing

Added the Billing API. Use this API to retrieve billing information for your organization, clusters, App Services, and the Couchbase AI Data Plane. You can view usage data by date range and filter it by category, project, or instance.

The Get Itemized Billing Per Cluster and Download Itemized Billing endpoints support operational clusters only.

Get Cluster Capacity Statistics

Use this operation to get cluster-level capacity statistics. For example, you can retrieve memory availability, replica limits, and other capacity metrics.

Update Organization Configuration

Use this operation to add, update, and delete network subdomains for clusters deployed on any cloud service provider (CSP). This operation is only available upon request. For more information, contact Couchbase Capella Support.

Resume App Service Log Streaming
Pause App Service Log Streaming
Configure App Service Log Streaming
Get App Service Log Streaming Configuration and State
Disable App Service Log Streaming
Update App Endpoint Log Streaming Config
Get App Endpoint Log Streaming Config

Added the App Services Log Streaming API. Use this API to stream App Services operational logs to third-party observability platforms or self-hosted HTTP log collectors. For more information, see Manage Log Streaming with the Management API.

Get Azure Application ID For Project
Create Azure Key Metadata For Project
List Azure Key Metadata For Project
Get Azure Key Metadata For Project
Rotate Azure Key For Project
Delete Azure Key Metadata For Project
Enable Azure CMEK For Project

Added project level endpoints to the CMEK API. Use these operations to manage CMEK at the project level. For more information, see Use Customer-Managed Encryption Keys (CMEK).

Get Cluster On/Off Schedule
Pause Cluster On/Off Schedule
Unpause Cluster On/Off Schedule

Added endpoints to the On/Off Schedule API. Use these operations to pause and unpause your cluster’s on/off schedule.

Get Private Endpoint Service Status

You can now use this operation to verify the status of XDCR and Prometheus metrics on your private endpoint.

Enable Private Endpoint Service

You can now use this operation to enable XDCR and Prometheus metrics when you enable the private endpoint service on your cluster.

Update Private Endpoint Service Configuration

Use this operation to enable or disable XDCR and Prometheus metrics access on an already enabled private endpoint service.

Get Azure Application ID

Use this operation to get your application ID from Capella. Create a new service principal in your Azure tenant using this application ID to use CMEK on your Azure operational clusters. For more information, see Enable Customer-Managed Encryption Keys on Capella.

Enable CMEK For Cloud Services Provider

Use this operation to enable customer-managed encryption keys for the specified cloud service provider within your organization. For more information, see Enable Customer-Managed Encryption Keys on Capella.

Create Key Metadata
List Key Metadata
Get Key Metadata
Rotate Key

These operations have been updated to support the keyLocation field required in an AzureConfig, to use CMEK on Azure operational clusters.

Create a new replication

You can now choose between async and sync mode when creating a replication. The default mode is async.

Get replication job details

Use this operation to get the status of the asynchronous creation of the replication. It provides full details on the replication job after the job completes.

Configure App Service Audit Log Streaming

You can now choose dynatrace as a provider for audit log streaming.

Create App Endpoint OpenID Connect (OIDC) Provider
Update App Endpoint OpenID Connect (OIDC) Provider

You can now include a scope field to define the scopes used in your OpenID Connect (OIDC) request. The default scopes are openid and email.

List AI Workflows
Create AI Workflow
Get AI Workflow
Delete AI Workflow
List AI Workflow Runs
Run an AI Workflow
Stop AI Workflow Run
Get AI Workflow Run
Get AI Workflow Run Processed Files

Added the Workflows API. This enables you to vectorize structured or unstructured data stored in Capella operational clusters or in external files.

List Providers
Create provider
Get provider
Update provider
Delete provider

Added the Providers API. This enables you to use integrations with external services required by the AI Data Plane. Use these endpoints to help interactions with external services providers required by the AI Data Plane.

List Models
Create Model
Get Model
Delete Model
Get Model Connection String

Added the Models (AI Data Plane) API. This enables you to deploy and manage AI models. This includes open LLMs like Llama3 and embedding models.

Create Model API Key
List Model API keys
Get Model API Key
Delete Model API key

Added the Model Services API Keys (AI Data Plane) API. This enables you to create and manage API keys for your AI models, ensuring secure and controlled access models while you use them.

Update Data API
Get Data API Status
Get Data API Private Endpoints Command
List Data API Private Endpoints
Accept Data API Private Endpoint Connection
Disassociate Data API Private Endpoint

Added Data API endpoints to the Management API. These enable you to enable or disable the Data API, to configure the Data API for use over VPC peering or a private endpoint, and to get the base URL for connecting to the Data API. For more information, see Manage Data with the Data API.

Get replication details
Delete a replication
Update an existing replication
List replications for a given cluster
Create a new replication
List replications for a given project
Pause a replication
Resume a replication

Added the XDCR API. This enables you to create a replication between 2 Capella operational clusters, or between a Capella operational cluster and a self-managed cluster.

List Available Geographic Regions for Cross-region Operations

This enables you to list the geographic regions where replicas of the original backups can be stored.

Enable App Service Private Endpoints
Get App Service Private Endpoints State
Get App Service Private Endpoints Command
List App Service Private Endpoints
Accept Private Endpoint Request
Delete Private Endpoint Request
Disable App Service Private Endpoints

Added the App Services Private Endpoints API. This enables you to connect to App Services over a secure private endpoint. Initially only available using Amazon Web Services (AWS). For details, see Private Endpoints for App Services.

List Cloud Snapshot Backups at the Project Level

This enables you to list the cluster (cloud snapshot) backups associated with operational clusters within a specific project.

Clone Cluster Backup

This enables you to clone and restore a cluster (cloud snapshot) backup from one cluster to another new cluster.

Delete Cluster

The retain snapshot backups parameter is available in the Delete Cluster endpoint. This parameter specifies whether you want to retain cluster (cloud snapshot) backups after cluster deletion.

Delete App Service Allowed CIDR
List Allowed CIDRs for an App Service
Create Allowed CIDR

Added the Allowed CIDRs (App Services) API. This enables you to manage the trusted IP addresses for your App Service.

List App Endpoint Collections

This enables you to list all the collections under a specific App Endpoint.

Get the App Endpoint CORS Configuration
Upsert the App Endpoint CORS Configuration

These enable you to manage the Cross-Origin Resource Sharing (CORS) configuration of a specific App Endpoint.

Create App Endpoint OIDC Provider
List App Endpoint OIDC Providers
Get App Endpoint OIDC Providers
Update App Endpoint OIDC Providers
Delete App Endpoint OIDC Providers
Update App Endpoint Default OIDC Provider

These enable you to manage the OpenID Connect (OIDC) provider for a specific App Endpoint.

Get Public Certificate for App Service

This enables you to retrieve your App Service’s public certificate. You can copy or download the endpoint’s SSL public certificate to bundle into your mobile application.

Create App Service Admin User
List App Service Admin Users
Update App Service Admin User
Delete App Service Admin User
Get App Service Admin User
List App Endpoints Admin Users

These enable you to manage users with an admin credential specific to a particular App Service or App Endpoint.

Create Free Tier Cluster
Get Free Tier Cluster
Update Free Tier Cluster
Delete Free Tier Cluster
Turn On Free Tier Cluster
Turn Off Free Tier Cluster
Create Free Tier App Service
Get Free Tier App Service
Update Free Tier App Service
Delete Free Tier App Service
Create Free Tier Bucket
List Free Tier Buckets
Get Free Tier Bucket
Update Free Tier Bucket
Delete Free Tier Bucket

Added the Free Tier API. This enables you to manage and monitor your free tier operational cluster and App Service.

Create New Operational Insights Cluster

The Operational Insights Clusters endpoint now supports Google Cloud Platform (GCP).

Get Operational Insights Private Endpoint Service Status
Enable Operational Insights Private Endpoint Service
Disable Operational Insights Private Endpoint Service
Get Operational Insights Private Endpoint CLI Command Required to Setup Private Endpoint for Specific CSP
List Operational Insights Private Endpoint Connections
Accept or Associate Operational Insights Private Endpoint Request
Reject or Disassociate Operational Insights Private Endpoint Connection

Added the Operational Insights Private Endpoint Service and VPC Peering API. This enables you to access Operational Insights from your cloud provider’s private network.

List App Endpoints
Create App Endpoint
Get App Endpoint
Update App Endpoint
Delete App Endpoint
Resume or Bring an App Endpoint online
Pause or Take an App Endpoint offline
Get Access Control and Validation function
Upsert Access Control and Validation function
Delete Access Control and Validation function
Get Import Filter
Upsert Import Filter
Delete Import Filter
Get Resync Status
Start Resync
Stop Resync

Added the App Endpoints API. This enables you to manage and monitor App Endpoints linked to your Capella Operational cluster. App Endpoints are instances of mobile applications deployed on App Services.

Manage Query Indexes
Get List of Index Definitions
Get Index Definition
Get Index Build Status

Added the GSI API. This enables you to manage and monitor GSI indexes on the Couchbase Capella cluster.

Create Cloud Snapshot Backup
List Cloud Snapshot Backups
Update Backup Retention
Delete Backup
Restore Backup
List Cloud Snapshot Restores

Added the Operational Insights Cloud Snapshot Backups & Restore API. This enables you to perform on-demand backups of Operational Insights cloud snapshot data.

Upsert Backup Schedule
Get Backup Schedule
Delete Backup Schedule

Added the Operational Insights Cloud Snapshot Backups Schedule API. This enables you to schedule automatic backups of Operational Insights cloud snapshot data.

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: Cluster Viewer, Data Writer, and 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 — 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.