--- title: Capella Operational Management API Change Log description: The change log for the Couchbase Capella Operational Management API. pubDate: 2026-08-17T09:53:44.266Z antora: editUrl: https://github.com/couchbase/docs-capella/edit/main/modules/management-api-guide/pages/management-api-log.adoc xref: xref:cloud:management-api-guide:management-api-log.adoc[] --- [Consult the llms.txt file for a full list of contents](/llms.txt) [View original HTML](/cloud/management-api-guide/management-api-log.html) # Capella Operational Management API Change Log This page is for Capella operational. For the Couchbase AI Data Plane, see [The Couchbase AI Data Plane API Change Log](../../ai/api-guide/api-log.md). For Capella Analytics, see [Capella Analytics Management API Change Log](../../analytics/management-api-guide/management-api-log.md). ## [](#version-4-0-0)Version 4.0.0 Initial release. ## [](#june-2026-changes)June 2026 Changes | Operation | Details | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Get Eventing Function Code](../management-api-reference/index.md#tag/Eventing-Functions/operation/getFunctionCode) [Update Eventing Function Code](../management-api-reference/index.md#tag/Eventing-Functions/operation/updateFunctionCode) [Get Eventing Function](../management-api-reference/index.md#tag/Eventing-Functions/operation/getEventingFunction) [Delete Eventing Function](../management-api-reference/index.md#tag/Eventing-Functions/operation/deleteEventingFunction) [Update Eventing Function](../management-api-reference/index.md#tag/Eventing-Functions/operation/putEventingFunction) [Create Eventing Function](../management-api-reference/index.md#tag/Eventing-Functions/operation/postEventingFunction) [List Eventing Functions](../management-api-reference/index.md#tag/Eventing-Functions/operation/listEventingFunctions) [Set Eventing Function State](../management-api-reference/index.md#tag/Eventing-Functions/operation/setFunctionState) [Get Function Logs](../management-api-reference/index.md#tag/Eventing-Functions/operation/getFunctionLogs) | 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](../eventing/eventing-overview.md#eventing-functions). | | [Create Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/postAlertIntegration) [List Alert Integrations](../management-api-reference/index.md#tag/Alert-Integration/operation/listAlertIntegrations) [List Channels for an Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/postListAlertIntegrationChannels) [Get Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/getAlertIntegrationByID) [Update Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/putAlertIntegration) [Delete Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/deleteAlertIntegrationByID) [Test Alert Integration](../management-api-reference/index.md#tag/Alert-Integration/operation/postTestAlertIntegration) | 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](../clusters/monitoring/alert-integration.md). | ### [](#may-2026-changes)May 2026 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Update Deletion Protection](../management-api-reference/index.md#tag/Clusters/operation/putClusterDeletionProtection) | 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](../management-api-reference/index.md#tag/Billing/operation/categorizedBilling) [Get Itemized Billing Per Cluster](../management-api-reference/index.md#tag/Billing/operation/itemizedBillingPerCluster) [Get Prepaid Credits Billing](../management-api-reference/index.md#tag/Billing/operation/prepaidCreditsBilling) [Get Pay As You Go Billing](../management-api-reference/index.md#tag/Billing/operation/payAsYouGoBilling) [Download Categorized Billing](../management-api-reference/index.md#tag/Billing/operation/downloadCategorizedBilling) [Download Itemized Billing](../management-api-reference/index.md#tag/Billing/operation/downloadItemizedBilling) | 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](../management-api-reference/index.md#tag/Billing/operation/itemizedBillingPerCluster) and [Download Itemized Billing](../management-api-reference/index.md#tag/Billing/operation/downloadItemizedBilling) endpoints support operational clusters only. | ### [](#april-2026-changes)April 2026 Changes | Operation | Details | | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Get Cluster Capacity Statistics](../management-api-reference/index.md#tag/Clusters/operation/getClusterStats) | Use this operation to get cluster-level capacity statistics. For example, you can retrieve memory availability, replica limits, and other capacity metrics. | ### [](#february-2026-changes)February 2026 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Update Organization Configuration](../management-api-reference/index.md#tag/Organizations/operation/putOrganizationConfiguration) | 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](../support/manage-support.md#create-support-ticket). | | [Resume App Service Log Streaming](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/resumeAppServiceLogStreaming) [Pause App Service Log Streaming](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/pauseAppServiceLogStreaming) [Configure App Service Log Streaming](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/postAppServiceLogStreaming) [Get App Service Log Streaming Configuration and State](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/getAppServiceLogStreaming) [Disable App Service Log Streaming](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/deleteAppServiceLogStreaming) [Update App Endpoint Log Streaming Config](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/putAppEndpointLogStreamingConfig) [Get App Endpoint Log Streaming Config](../management-api-reference/index.md#tag/App-Services-Log-Streaming/operation/getAppEndpointLogStreamingConfig) | 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](../../app-services/monitoring/manage-log-streaming.md). | | [Get Azure Application ID For Project](../management-api-reference/index.md#tag/CMEK/operation/getAzureApplicationIDForProject) [Create Azure Key Metadata For Project](../management-api-reference/index.md#tag/CMEK/operation/postCMEKAzureMetadataForProject) [List Azure Key Metadata For Project ](../management-api-reference/index.md#tag/CMEK/operation/getAzureKeyMetadataListForProject) [Get Azure Key Metadata For Project](../management-api-reference/index.md#tag/CMEK/operation/getAzureKeyMetadataForProject) [Rotate Azure Key For Project](../management-api-reference/index.md#tag/CMEK/operation/rotateAzureKeyMetadataForProject) [Delete Azure Key Metadata For Project ](../management-api-reference/index.md#tag/CMEK/operation/deleteAzureKeyMetadataForProject) [Enable Azure CMEK For Project](../management-api-reference/index.md#tag/CMEK/operation/enableCMEKAzureProject) | 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)](../security/cmek.md). | | [Get Cluster On/Off Schedule](../management-api-reference/index.md#tag/OnOff-Schedule/operation/getOnOffSchedule) [Pause Cluster On/Off Schedule](../management-api-reference/index.md#tag/OnOff-Schedule/operation/pauseClusterOnOffSchedule) [Unpause Cluster On/Off Schedule](../management-api-reference/index.md#tag/OnOff-Schedule/operation/unpauseClusterOnOffSchedule) | 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](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/getPrivateEndpointServiceStatus) | You can now use this operation to verify the status of XDCR and Prometheus metrics on your private endpoint. | | [Enable Private Endpoint Service](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/enablePrivateEndpointService) | 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](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/updatePrivateEndpointService) | Use this operation to enable or disable XDCR and Prometheus metrics access on an already enabled private endpoint service. | ### [](#december-2025-changes)December 2025 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Get Azure Application ID](../management-api-reference/index.md#tag/CMEK/operation/getAzureApplicationID) | 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](../security/cmek.md#enable-cmek). | | [Enable CMEK For Cloud Services Provider](../management-api-reference/index.md#tag/CMEK/operation/enableCMEK) | 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](../security/cmek.md#enable-cmek). | | [Create Key Metadata](../management-api-reference/index.md#tag/CMEK/operation/postCMEKMetadata) [List Key Metadata](../management-api-reference/index.md#tag/CMEK/operation/getKeyMetadataList) [Get Key Metadata](../management-api-reference/index.md#tag/CMEK/operation/getKeyMetadata) [Rotate Key](../management-api-reference/index.md#tag/CMEK/operation/rotateCMEKKey) | These operations have been updated to support the keyLocation field required in an AzureConfig, to use CMEK on Azure operational clusters. | ### [](#november-2025-changes)November 2025 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Create a new replication](../management-api-reference/index.md#tag/Replications/operation/createReplication) | You can now choose between async and sync mode when creating a replication. The default mode is async. | | [Get replication job details](../management-api-reference/index.md#tag/Replications/operation/getReplicationJob) | 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](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/putAppServiceAuditLogStreaming) | You can now choose dynatrace as a provider for audit log streaming. | | [Create App Endpoint OpenID Connect (OIDC) Provider](../management-api-reference/index.md#tag/App-Endpoints/operation/createAppEndpointOIDCProvider) [Update App Endpoint OpenID Connect (OIDC) Provider](../management-api-reference/index.md#tag/App-Endpoints/operation/updateAppEndpointOIDCProvider) | 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. | ### [](#october-2025-changes)October 2025 Changes | Operation | Details | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Update Data API](../management-api-reference/index.md#tag/Data-API/operation/updateDataApiAndPeering) [Get Data API Status](../management-api-reference/index.md#tag/Data-API/operation/getDataAPIStatus) [Get Data API Private Endpoints Command](../management-api-reference/index.md#tag/Data-API/operation/getDataAPIPrivateEndpointCommand) [List Data API Private Endpoints](../management-api-reference/index.md#tag/Data-API/operation/listDataAPIPrivateEndpoints) [Accept Data API Private Endpoint Connection](../management-api-reference/index.md#tag/Data-API/operation/associateDataAPIPrivateEndpointRequest) [Disassociate Data API Private Endpoint](../management-api-reference/index.md#tag/Data-API/operation/disassociateDataAPIPrivateEndpoint) | 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](../data-api-guide/data-api-intro.md). | ### [](#september-2025-changes)September 2025 Changes | Operation | Details | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Get replication details](../management-api-reference/index.md#tag/Replications/operation/getReplication) [Delete a replication](../management-api-reference/index.md#tag/Replications/operation/deleteReplication) [Update an existing replication](../management-api-reference/index.md#tag/Replications/operation/updateReplication) [List replications for a given cluster](../management-api-reference/index.md#tag/Replications/operation/listClusterReplications) [Create a new replication](../management-api-reference/index.md#tag/Replications/operation/createReplication) [List replications for a given project](../management-api-reference/index.md#tag/Replications/operation/listProjectReplications) [Pause a replication](../management-api-reference/index.md#tag/Replications/operation/pauseReplication) [Resume a replication](../management-api-reference/index.md#tag/Replications/operation/resumeReplication) | 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](../management-api-reference/index.md#tag/Cloud-Snapshot-Backups-and-Restore/operation/ListGeographicRegions) | This enables you to list the geographic regions where replicas of the original backups can be stored. | ### [](#july-2025-changes)July 2025 Changes | Operation | Details | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Enable App Service Private Endpoints](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/postAppServicePrivateEndpoints) [Get App Service Private Endpoints State](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/getAppServicePrivateEndpoints) [Get App Service Private Endpoints Command](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/getAppServicePrivateEndpointsCommand) [List App Service Private Endpoints](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/listAppServicePrivateEndpoints) [Accept Private Endpoint Request](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/acceptPrivateEndpointRequest) [Delete Private Endpoint Request](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/deletePrivateEndpointRequest) [Disable App Service Private Endpoints](../management-api-reference/index.md#tag/App-Services-Private-Endpoints/operation/deleteAppServicePrivateEndpoints) | 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](../../app-services/private-endpoints/app-services-private-endpoints.md). | ### [](#june-2025-changes)June 2025 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [List Cloud Snapshot Backups at the Project Level](../management-api-reference/index.md#tag/Cloud-Snapshot-Backups-and-Restore/operation/listProjectLevelCloudSnapshotBackups) | This enables you to list the cluster (cloud snapshot) backups associated with operational clusters within a specific project. | | [Clone Cluster Backup](../management-api-reference/index.md#tag/Cloud-Snapshot-Backups-and-Restore/operation/clone) | This enables you to clone and restore a cluster (cloud snapshot) backup from one cluster to another new cluster. | | [Delete Cluster](../management-api-reference/index.md#tag/Clusters/operation/deleteCluster) | 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. | ### [](#may-2025-changes)May 2025 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Delete App Service Allowed CIDR](../management-api-reference/index.md#tag/Allowed-CIDRs-%28App-Services%29/operation/deleteAppServiceAllowedCidr) [List Allowed CIDRs for an App Service](../management-api-reference/index.md#tag/Allowed-CIDRs-%28App-Services%29/operation/listAppServiceAllowedCidrs) [Create Allowed CIDR](../management-api-reference/index.md#tag/Allowed-CIDRs-%28App-Services%29/operation/postAppServiceAllowedCidr) | Added the Allowed CIDRs (App Services) API. This enables you to manage the trusted IP addresses for your App Service. | | [List App Endpoint Collections](../management-api-reference/index.md#tag/App-Endpoints/operation/listAppEndpointCollections) | This enables you to list all the collections under a specific App Endpoint. | | [Get the App Endpoint CORS Configuration](../management-api-reference/index.md#tag/App-Endpoints/operation/getAppEndpointCORS) [Upsert the App Endpoint CORS Configuration](../management-api-reference/index.md#tag/App-Endpoints/operation/putAppEndpointCORS) | These enable you to manage the Cross-Origin Resource Sharing (CORS) configuration of a specific App Endpoint. | | [Create App Endpoint OIDC Provider](../management-api-reference/index.md#tag/App-Endpoints/operation/createAppEndpointOIDCProvider) [List App Endpoint OIDC Providers](../management-api-reference/index.md#tag/App-Endpoints/operation/listAppEndpointOIDCProviders) [Get App Endpoint OIDC Providers](../management-api-reference/index.md#tag/App-Endpoints/operation/getAppEndpointOIDCProvider) [Update App Endpoint OIDC Providers](../management-api-reference/index.md#tag/App-Endpoints/operation/updateAppEndpointOIDCProvider) [Delete App Endpoint OIDC Providers](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteAppEndpointOIDCProvider) [Update App Endpoint Default OIDC Provider](../management-api-reference/index.md#tag/App-Endpoints/operation/updateAppEndpointOIDCDefaultProvider) | These enable you to manage the OpenID Connect (OIDC) provider for a specific App Endpoint. | | [Get Public Certificate for App Service](../management-api-reference/index.md#tag/App-Services/operation/getAppServiceCertificate) | 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](../management-api-reference/index.md#tag/App-Services/operation/AddAppServiceAdminUser) [List App Service Admin Users](../management-api-reference/index.md#tag/App-Services/operation/ListAppServiceAdminUsers) [Update App Service Admin User](../management-api-reference/index.md#tag/App-Services/operation/UpdateAppServiceAdminUser) [Delete App Service Admin User](../management-api-reference/index.md#tag/App-Services/operation/DeleteAppServiceAdminUser) [Get App Service Admin User](../management-api-reference/index.md#tag/App-Services/operation/getAppServiceAdminUser) [List App Endpoints Admin Users](../management-api-reference/index.md#tag/App-Services/operation/ListAppEndpointAdminUsers) | These enable you to manage users with an admin credential specific to a particular App Service or App Endpoint. | ### [](#april-2025-changes)April 2025 Changes | Operation | Details | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | [Create Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/createFreeTierCluster) [Get Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/getFreeTierCluster) [Update Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/updateFreeTierCluster) [Delete Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/deleteFreeTierCluster) [Turn On Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/freeTierClusterOn) [Turn Off Free Tier Cluster](../management-api-reference/index.md#tag/Free-Tier/operation/freeTierClusterOff) [Create Free Tier App Service](../management-api-reference/index.md#tag/Free-Tier/operation/createFreeTierAppService) [Get Free Tier App Service](../management-api-reference/index.md#tag/Free-Tier/operation/getFreeTierAppService) [Update Free Tier App Service](../management-api-reference/index.md#tag/Free-Tier/operation/updateFreeTierAppService) [Delete Free Tier App Service](../management-api-reference/index.md#tag/Free-Tier/operation/deleteFreeTierAppService) [Create Free Tier Bucket](../management-api-reference/index.md#tag/Free-Tier/operation/createFreeTierBucket) [List Free Tier Buckets](../management-api-reference/index.md#tag/Free-Tier/operation/listFreeTierBuckets) [Get Free Tier Bucket](../management-api-reference/index.md#tag/Free-Tier/operation/getFreeTierBucketByID) [Update Free Tier Bucket](../management-api-reference/index.md#tag/Free-Tier/operation/updateFreeTierBucket) [Delete Free Tier Bucket](../management-api-reference/index.md#tag/Free-Tier/operation/deleteFreeTierBucketByID) | Added the Free Tier API. This enables you to manage and monitor your free tier operational cluster and App Service. | ### [](#january-2025-changes)January 2025 Changes | Operation | Details | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [List App Endpoints](../management-api-reference/index.md#tag/App-Endpoints/operation/listAppEndpoints) [Create App Endpoint](../management-api-reference/index.md#tag/App-Endpoints/operation/postAppEndpoint) [Get App Endpoint](../management-api-reference/index.md#tag/App-Endpoints/operation/getAppEndpoint) [Update App Endpoint](../management-api-reference/index.md#tag/App-Endpoints/operation/putAppEndpoint) [Delete App Endpoint](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteAppEndpoint) [Resume or Bring an App Endpoint online](../management-api-reference/index.md#tag/App-Endpoints/operation/postAppEndpointActivationStatus) [Pause or Take an App Endpoint offline](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteAppEndpointActivationStatus) [Get Access Control and Validation function](../management-api-reference/index.md#tag/App-Endpoints/operation/getAccessFunction) [Upsert Access Control and Validation function](../management-api-reference/index.md#tag/App-Endpoints/operation/putAccessFunction) [Delete Access Control and Validation function](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteAccessFunction) [Get Import Filter](../management-api-reference/index.md#tag/App-Endpoints/operation/getImportFilter) [Upsert Import Filter](../management-api-reference/index.md#tag/App-Endpoints/operation/putImportFilter) [Delete Import Filter](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteImportFilter) [Get Resync Status](../management-api-reference/index.md#tag/App-Endpoints/operation/getAppEndpointResync) [Start Resync](../management-api-reference/index.md#tag/App-Endpoints/operation/postAppEndpointResync) [Stop Resync](../management-api-reference/index.md#tag/App-Endpoints/operation/deleteAppEndpointResync) | 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. | ### [](#november-2024-changes)November 2024 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | [Manage Query Indexes](../management-api-reference/index.md#tag/Query-Indexes/operation/manageQueryIndexes) [Get List of Index Definitions](../management-api-reference/index.md#tag/Query-Indexes/operation/listIndexDefinitions) [Get Index Definition](../management-api-reference/index.md#tag/Query-Indexes/operation/indexDefinition) [Get Index Build Status](../management-api-reference/index.md#tag/Query-Indexes/operation/indexBuildStatus) | Added the GSI API. This enables you to manage and monitor GSI indexes on the Couchbase Capella cluster. | ### [](#september-2024-changes)September 2024 Changes | Operation | Details | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Flush Bucket Data](../management-api-reference/index.md#tag/Buckets-Scopes-and-Collections/operation/FlushBucket) | This enables you to delete all of the data presently stored in a bucket. | | [Create Bucket](../management-api-reference/index.md#tag/Buckets-Scopes-and-Collections/operation/postBucket) | The flush field is now deprecated and the flushEnabled field is available in the Create Bucket endpoint. | | [Enable or Disable App Service Audit Logging](#management-api-reference:index.adoctag/App-Services-Audit-Logging/operation/putAppServiceAuditLogState) [Get App Service Audit Log State](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/getAppServiceAuditLogState) [List App Endpoint Audit Log Event IDs](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/getAppServiceAuditLogEvents) [Update App Endpoint Audit Logging Config](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/putAppEndpointAuditLogConfig) [Get App Endpoint Audit Logging Config](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/getAppEndpointAuditLogConfig) [Configure App Service Audit Log Streaming](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/putAppServiceAuditLogStreaming) [Start or Resume Audit Log Streaming](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/patchAppServiceAuditLogStreaming) [Get App Service Audit Log Streaming State](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/getAppServiceAuditLogStreaming) [Initiate Audit Log Export](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/postAppServiceAuditLogExport) [List Audit Log Export Jobs](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/listAppServiceAuditLogExports) [Get Audit Log Export Job](../management-api-reference/index.md#tag/App-Services-Audit-Logging/operation/getAppServiceAuditLogExportById) | Added the App Services Audit Logging API. This enables you to configure and retrieve audit logs for App Services. For details, see [Audit Logging](../../app-services/monitoring/audit-logging.md). | | [Create Cluster](../management-api-reference/index.md#tag/Clusters/operation/postCluster) | 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](../support/manage-support.md#create-support-ticket). | | [List Key Rotation History](../management-api-reference/index.md#tag/CMEK/operation/listCMEKHistory) | 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](../management-api-reference/index.md#tag/Network-Peers/operation/postNetworkPeering) [List Network Peering Records](../management-api-reference/index.md#tag/Network-Peers/operation/listNetworkPeeringRecords) [Get Network Peering record](../management-api-reference/index.md#tag/Network-Peers/operation/getNetworkPeeringRecord) [Get Azure VNET Peering CLI Command](../management-api-reference/index.md#tag/Network-Peers/operation/getAzureVnetPeeringCommand) | 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. | ### [](#august-2024-changes)August 2024 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | [Get Private Endpoint Service Status](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/getPrivateEndpointServiceStatus) [Enable Private Endpoint Service](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/enablePrivateEndpointService) [Disable Private Endpoint Service](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/disablePrivateEndpointService) [List Private Endpoints](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/listPrivateEndpoints) [Get Private Endpoint CLI Command](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/getPrivateEndpointCommand) [Accept Private Endpoint Request](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/acceptPrivateEndpoint) [Reject or disassociate Private Endpoint](../management-api-reference/index.md#tag/Private-Endpoint-Service/operation/deletePrivateEndpoint) | Added the Private Endpoint Service API. This enables you to access your Capella cluster from your cloud provider's private network. | ### [](#july-2024-changes)July 2024 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Create Cluster](../management-api-reference/index.md#tag/Clusters/operation/postCluster) | The configurationType field in the Create Cluster endpoint is now deprecated. | | [List Events](../management-api-reference/index.md#tag/Events/operation/listEvents) [Get Event](../management-api-reference/index.md#tag/Events/operation/getEventByID) [List Events](../management-api-reference/index.md#tag/Events/operation/listProjectEvents) [Get Project Event](../management-api-reference/index.md#tag/Events/operation/getProjectEventByID) | 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. | ### [](#june-2024-changes)June 2024 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Create Network Peering](../management-api-reference/index.md#tag/Network-Peers/operation/postNetworkPeering) [List Network Peering Records](../management-api-reference/index.md#tag/Network-Peers/operation/listNetworkPeeringRecords) [Get Network Peering record](../management-api-reference/index.md#tag/Network-Peers/operation/getNetworkPeeringRecord) [Delete Network Peering](../management-api-reference/index.md#tag/Network-Peers/operation/deleteNetworkPeering) | 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. | ### [](#may-2024-changes)May 2024 Changes | Operation | Details | | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Create Cluster Audit Log Export job](../management-api-reference/index.md#tag/Audit-Logs/operation/postAuditLogExport) | The Create Cluster Audit Log job API now supports the following RBAC roles: Cluster Viewer, Data Writer, and Data Reader. | | [Migrate Buckets](../management-api-reference/index.md#tag/Clusters/operation/putBucketStorageBackend) | 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](../management-api-reference/index.md#tag/organizations/operation/putOrganizationConfiguration) | Organization owners can now add, update, and delete custom subdomains for AWS clusters. Reach out to Couchbase support to enable this feature. | | [Update Username](../management-api-reference/index.md#tag/Users) | Temporarily removed the operation to update a user name. | ### [](#april-2024-changes)April 2024 Changes | Operation | Details | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | [Update Cluster Audit Log Configuration](../management-api-reference/index.md#tag/Audit-Logs/operation/putClusterAuditSettings) [Get Cluster Audit Log Configuration](../management-api-reference/index.md#tag/Audit-Logs/operation/getClusterAuditSettings) [List Filterable Audit Log Events](../management-api-reference/index.md#tag/Audit-Logs/operation/getAuditLogEventIDs) [Create Cluster Audit Log Export Job](../management-api-reference/index.md#tag/Audit-Logs/operation/postAuditLogExport) [List Cluster Audit Log Export Jobs](../management-api-reference/index.md#tag/Audit-Logs/operation/listAuditLogExports) [Get Cluster Audit Log Export](../management-api-reference/index.md#tag/Audit-Logs/operation/getAuditLogExport) | Added the Audit Log API. This enables you to configure auditing on your Capella cluster, and export audit logs to an AWS S3 bucket. | ### [](#march-2024-changes)March 2024 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | [Update Collection](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/putCollection) [Create Alert Integration](../management-api-reference/index.md#tag/alert-integration/operation/postAlertIntegration) [List Alert Integrations](../management-api-reference/index.md#tag/alert-integration/operation/listAlertIntegrations) [Get Alert Integration](../management-api-reference/index.md#tag/alert-integration/operation/getAlertIntegrationByID) [Update Alert Integration](../management-api-reference/index.md#tag/alert-integration/operation/putAlertIntegration) [Delete Alert Integration](../management-api-reference/index.md#tag/alert-integration/operation/deleteAlertIntegrationByID) [Test Alert Integration](../management-api-reference/index.md#tag/alert-integration/operation/postTestAlertIntegration) | Added the Alert Integration API. This enables you to send Capella alert notifications to common services, such as ServiceNow. | ### [](#february-2024-changes)February 2024 Changes | Operation | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Create Cluster On/Off schedule](../management-api-reference/index.md#tag/onoff-schedule/operation/postOnOffSchedule) [Get Cluster On/Off schedule](../management-api-reference/index.md#tag/onoff-schedule/operation/getOnOffSchedule) [Update Cluster On/Off schedule](../management-api-reference/index.md#tag/onoff-schedule/operation/putOnOffSchedule) [Delete Cluster On/Off schedule](../management-api-reference/index.md#tag/onoff-schedule/operation/deleteOnOffSchedule) | 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](../management-api-reference/index.md#tag/clusters/operation/postCluster) [List Clusters](../management-api-reference/index.md#tag/clusters/operation/listClusters) [Get Cluster](../management-api-reference/index.md#tag/clusters/operation/getCluster) [Update Cluster](../management-api-reference/index.md#tag/clusters/operation/putCluster) | 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. | ### [](#january-2024-changes)January 2024 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Create Key Metadata](../management-api-reference/index.md#tag/cmek/operation/postCMEKMetadata) [List Key Metadata](../management-api-reference/index.md#tag/cmek/operation/getKeyMetadataList) [Get Key Metadata](../management-api-reference/index.md#tag/cmek/operation/getKeyMetadata) [Rotate Key](../management-api-reference/index.md#tag/cmek/operation/rotateCMEKKey) [Delete Key Metadata](../management-api-reference/index.md#tag/cmek/operation/deleteKeyMetadata) [Associate Key with Cluster](../management-api-reference/index.md#tag/cmek/operation/AssociateCMEK) [Disassociate Key from Cluster](../management-api-reference/index.md#tag/cmek/operation/UnassociateCMEK) | Added the Customer Managed Encryption Keys API. This enables you to manage encryption keys. | | [Get Scope](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/getScopeByName) [Delete Scope](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/deleteScopeByName) [List Scopes](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/getScopes) [Create Scope](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/postScope) [Get Collection](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/getCollectionByName) [Delete Collection](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/deleteCollectionByName) [List Collections](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/getCollections) [Create Collection](../management-api-reference/index.md#tag/buckets-scopes-and-collections/operation/postCollection) | 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](../management-api-reference/index.md#tag/sampleBucket/operation/postSampleBucket) [List Sample Data Import Buckets](../management-api-reference/index.md#tag/sampleBucket/operation/listSampleBuckets) [Get Sample Import Bucket](../management-api-reference/index.md#tag/sampleBucket/operation/getSampleBucketById) [Delete Sample Import Bucket](../management-api-reference/index.md#tag/sampleBucket/operation/deleteSampleDataByBucketID) | 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. | ### [](#december-2023-changes)December 2023 Changes | Operation | Details | | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | [Update Username](../management-api-reference/index.md#tag/users/operation/putUsername) | Organization owners can now update user names for any user in the organization. | ### [](#october-2023-changes)October 2023 Changes | Operation | Details | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Create Cluster](../management-api-reference/index.md#tag/clusters/operation/postCluster) | 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](../management-api-reference/index.md#tag/clusters/operation/getCluster) | Getting details of a cluster now returns the connection string — the cluster endpoint for the client connection. | | [Create Cluster Credentials](../management-api-reference/index.md#tag/databaseCredentials/operation/postDatabaseCredential) | Documentation for the request body now describes restrictions on the cluster credential name and the associated password. | | [Update Project](../management-api-reference/index.md#tag/projects/operation/putProject) [Update Cluster](../management-api-reference/index.md#tag/clusters/operation/putCluster) [Update App Service Specs](../management-api-reference/index.md#tag/appServices/operation/putAppService) | 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](../management-api-reference/index.md#tag/users/operation/patchUser) | Corrected responses to show that the ETag is not returned for this operation. | | [List API Keys](../management-api-reference/index.md#tag/apikeys/operation/listOrganizationAPIKeys) [List Projects](../management-api-reference/index.md#tag/projects/operation/listProjects) [List Clusters](../management-api-reference/index.md#tag/clusters/operation/listClusters) [List Users](../management-api-reference/index.md#tag/users/operation/listUsers) [List Allowed CIDRs](../management-api-reference/index.md#tag/allowedCIDRs%28Cluster%29/operation/listAllowedCidrs) [List Cluster Credentials](../management-api-reference/index.md#tag/databaseCredentials/operation/listDatabaseCredentials) [List App Services](../management-api-reference/index.md#tag/appServices/operation/listAppServices) | Documentation now lists valid values for the sortBy field for each endpoint. | ## [](#see-also)See Also * For details of the Management API, see [Manage Deployments with the Capella Operational Management API](management-api-intro.md). * For a full reference guide, see [Capella Operational Management API Reference](../management-api-reference/index.md).