The Management API uses semantic versioning. The full version number consists of 3 parts: major.minor.patch.

An update to the Management API may be a non-versioned bug fix, a patch update, a minor update, or a major update. All major, minor, and patch updates increment the version number. Only non-versioned bug fixes do not change the version number as they resolve defects without altering functionality or adding new features.

New versions of the Management API, with some exceptions, are backward compatible, minimizing the effect on existing deployments. In most cases, you do not need to update your existing infrastructure when Couchbase releases a new version of the Management API. Features added in a new version of the Management API do not break existing deployments.

Exceptions to backward compatibility are as follows:

The Management API v4.0 is the initial release of the Capella Analytics Management API. The version numbering of the Capella Analytics Management API is aligned with the version numbering of the Capella operational Management API.

The Management API uses API keys for authentication and authorization. They’re required for accessing endpoints exposed by the Management API.

Couchbase Capella associates API keys with roles and permissions. To access an endpoint, an API key must have the appropriate Capella roles. The Management API reference guide lists the roles required for each endpoint.

When you create an API key, you can configure an allowed IP address list. Every API key has an expiration date.

To authenticate a Management API call, pass the API key as a Bearer token in the HTTP Authorization header.

To support concurrent requests, PUT requests support optimistic concurrency control, using If-Match headers in combination with HTTP ETags (entity tags). Exceptions are noted in the endpoint descriptions of the Management API reference page. A typical pattern is to do a GET request on a specified resource, which returns an ETag value. You can then include the ETag value in a PUT request to update the resource.

PUT requests ignore all fields in the body of the request that are not required. You can find the required fields for each PUT request in the Management API reference guide.

All requests to the Management API are audited. All endpoints support Audit fields for audit purposes, except where noted in the Management API reference guide.

Lists are paginated.

Service limits set boundaries for managing clusters, App Services, and AI Services with the Management API.