Couchbase Capella Management API

Name: Couchbase Capella Management API
Brand: Couchbase Capella Management API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageDatabasebearer259 EndpointsREST

For Agents

Provision and manage Couchbase Capella clusters, projects, buckets, app services, backups, and access controls through the Capella v4 management API. Bearer-token authentication with 259 endpoints scoped to organisation, project, and cluster.

Install Jentic One Beta

Connect the Couchbase Capella Management API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Couchbase Capella Management API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Couchbase Capella Management API.

Create and tear down free-tier and standard Capella clusters under a project, including on/off schedules to manage cost

Manage projects, organisation API keys, and key rotation for fine-grained access control

Configure buckets, scopes, and collections plus their backup and restore schedules to keep data durable

GET STARTED

Start building with Couchbase Capella Management API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Couchbase Capella Management API, keeping it validated and agent-ready. The Couchbase Capella Management API is the v4 control plane for Couchbase's managed NoSQL database service, exposing 259 endpoints to provision and manage clusters, projects, buckets, scopes, collections, app services, backup schedules, audit logs, CIDR allowlists, API keys, and customer-managed encryption keys (CMEK). It also covers AI workflows, app endpoints, and on/off schedules so teams can fully automate the lifecycle of a Capella deployment from CI.

Use Cases

Patterns agents use Couchbase Capella Management API for, with concrete tasks.

★ Ephemeral Dev/Test Capella Clusters

Spin up Capella clusters at the start of an integration test job and tear them down when the job completes, scoped to the project that owns the test fixtures. The on/off schedule endpoints let teams park clusters overnight to keep costs predictable, and the free-tier cluster operations support quick demo environments.

On test start call POST /v4/organizations/{organizationId}/projects/{projectId}/clusters, run tests, then DELETE the cluster — or use POST /v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/onOffSchedule to park it overnight.

Compliance-Ready Bucket and Encryption Setup

When a regulated workload comes online, configure customer-managed encryption keys on the cloud provider, attach them to the Capella project, and then create the bucket with the correct backup schedule. Audit logging on the cluster ensures every change is captured for review.

Call POST /v4/organizations/{organizationId}/cmek to register the key, POST the bucket on the cluster, and PUT the audit log configuration to enable change capture.

Sync-Gateway-Style App Services Operations

Run the mobile sync surface (App Services) end-to-end: register endpoints, configure audit logging, stream logs to the team's observability stack, and lock down access with allowed CIDRs and private endpoints. Each subsystem has dedicated endpoints, so an operator can build a single playbook to roll out App Services across new clusters.

Call the App Endpoints, App Services Audit Logging, App Services Log Streaming, and App Services Private Endpoints endpoint groups under /v4/organizations/{organizationId}/projects/{projectId} to configure the surface for a cluster.

AI Agent Couchbase SRE Assistant via Jentic

An SRE agent answers questions like 'turn off the dev cluster every weekend' or 'rotate the production API key' by routing each request to the right Capella v4 operation through Jentic. The agent reasons over capabilities and Jentic returns the right operation schema rather than the agent juggling 259 endpoints.

Search Jentic for 'create Capella cluster on/off schedule' or 'rotate Capella API key', load the matching operation, and execute it with the organisation, project, and cluster IDs.

Key Endpoints

259 endpoints — jentic publishes the only available openapi specification for couchbase capella management api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v4/organizations/{organizationId}/projects

Create a project

POST

/v4/organizations/{organizationId}/projects/{projectId}/clusters

Create a cluster

GET

/v4/organizations/{organizationId}/projects/{projectId}/clusters

List clusters in a project

POST

/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/onOffSchedule

Create cluster on/off schedule

POST

/v4/organizations/{organizationId}/apikeys

Create an organisation API key

POST

/v4/organizations/{organizationId}/apikeys/{ApiKeyId}/rotate

Rotate an organisation API key

GET

/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/stats

Get cluster capacity stats

POST

/v4/organizations/{organizationId}/cmek

POST

/v4/organizations/{organizationId}/projects

Create a project

POST

/v4/organizations/{organizationId}/projects/{projectId}/clusters

Create a cluster

GET

/v4/organizations/{organizationId}/projects/{projectId}/clusters

List clusters in a project

POST

/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/onOffSchedule

Create cluster on/off schedule

POST

/v4/organizations/{organizationId}/apikeys

Create an organisation API key

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Capella organisation API key (used as a bearer token) is stored encrypted in the Jentic vault (MAXsystem). Agents receive a scoped execution handle — the key is injected into the Authorization header at call time and never enters the agent's prompt or logs.

Intent-based discovery

Agents search by intent (e.g., 'create Capella cluster' or 'rotate Capella API key') and Jentic returns the matching operation with input and response schemas, so the agent picks the right endpoint without navigating the 259-endpoint surface manually.

Time to first call

Direct Capella integration: 3-7 days for auth, scope plumbing, and consistent error mapping across hundreds of endpoints. Through Jentic: under 1 hour to chain search, load, and execute calls.

FAQs

Specific to using Couchbase Capella Management API through Jentic.

Why is there no official OpenAPI spec for Couchbase Capella Management API?

Couchbase publishes Capella documentation but not a single OpenAPI specification covering the v4 management surface. Jentic generates and maintains this spec so that AI agents and developers can call Couchbase Capella Management API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Couchbase Capella Management API use?

The API uses HTTP bearer-token authentication backed by an organisation API key created from the Capella console or from POST /v4/organizations/{organizationId}/apikeys. Through Jentic the key is held in the encrypted vault and injected into the Authorization header at execution time.

Can I create and turn off clusters on a schedule?

Yes. POST /v4/organizations/{organizationId}/projects/{projectId}/clusters creates a cluster, and POST /v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/onOffSchedule installs an on/off schedule that pauses the cluster outside working hours to control cost.

Does the API support customer-managed encryption keys?

Yes. The CMEK endpoint group lets you register key metadata at the organisation or project level for AWS, Azure, and GCP and attach those keys to clusters, which is the canonical primitive for compliance-driven workloads.

What are the rate limits for the Capella Management API?

The OpenAPI spec does not declare numeric rate limits. Treat HTTP 429 responses as authoritative, back off using the Retry-After header where present, and consult Couchbase docs for the limits that apply to your organisation tier before high-frequency operations.

How do I provision a free-tier cluster through Jentic?

Search Jentic for 'create Capella free tier cluster', load POST /v4/organizations/{organizationId}/projects/{projectId}/clusters/freeTier, and execute it with the organisation and project IDs and the cluster definition. Jentic returns the operation schema so the agent does not need to hand-craft the JSON body.

Couchbase Capella Management API

Connect the Couchbase Capella Management API to your agent

Capabilities

Start building with Couchbase Capella Management API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs