Couchbase Capella

App · 30 actions

Manage your Couchbase Capella databases: projects, clusters, buckets, scopes, collections and allowed IP addresses, and read, write, count, search and query documents.

Actions

ActionWhat it does
Add allowed addressAllow an IP address or range (like 203.0.113.0/24) to connect to a cluster, optionally until a time.
Change counterAdd to a counter document and return its new value; a negative amount subtracts.
Create bucketCreate a bucket, the top-level container for data.
Create collectionCreate a collection in a scope, the place documents are stored (like a table).
Create documentAdd a new document under a key.
Create projectCreate an empty project to group clusters.
Create scopeCreate a scope in a bucket, a named group of collections.
Delete allowed addressStop allowing an IP address or range to connect to a cluster.
Delete bucketDelete a bucket and every scope, collection and document in it.
Delete collectionDelete a collection and every document in it.
Delete documentDelete a document by its key.
Delete projectDelete a project.
Delete scopeDelete a scope with all its collections and documents.
Find documentsFind the documents in a collection whose field matches a value, with optional sorting.
Get bucketGet one bucket's settings and statistics.
Get clusterGet one cluster: its state, cloud and region, Couchbase version and connection string.
Get documentRead one document by its key.
Get projectGet one project with its name, description and who last changed it.
List allowed addressesList the IP addresses and ranges allowed to connect to a cluster.
List bucketsList a cluster's buckets with their settings, item counts and memory use.
List clustersList a project's database clusters with their state, cloud and connection string.
List collectionsList a scope's collections with their document lifetime.
List organizationsList the Capella organizations the API key can see, with their ids.
List projectsList an organization's projects, one page at a time.
List scopesList a bucket's scopes, each with its collections.
Run SQL++ queryRun a SQL++ (N1QL) statement, such as a SELECT, an UPDATE or CREATE INDEX, and get its rows back.
Update bucketChange a bucket's memory, durability, replicas, flush setting or document lifetime.
Update collectionChange how long documents in a collection are kept before Capella deletes them.
Update documentReplace the whole content of an existing document.
Update projectRename a project or change its description.

Add allowed address

Allow an IP address or range (like 203.0.113.0/24) to connect to a cluster, optionally until a time.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
IP address or rangecidrtextRequired
An IPv4 address, or a range such as 203.0.113.0/24.
Commentcommenttext
A note about why, shown in Capella.
Allowed untilexpires_atdate and time
Stop allowing it at this time. Leave empty to allow it until removed.

Outputs

allowed_cidrobject
The new entry
allowed_cidr_idtext
The new entry's id
Example output
{
  "allowed_cidr": {
    "audit": {
      "createdAt": "2026-10-15T09:00:00Z",
      "createdBy": "user-id",
      "modifiedAt": "2026-10-15T09:00:00Z",
      "modifiedBy": "user-id",
      "version": 1
    },
    "cidr": "203.0.113.0/24",
    "comment": "Office",
    "expiresAt": "",
    "id": "cidr-0001",
    "status": "active",
    "type": "permanent"
  },
  "allowed_cidr_id": "cidr-0001"
}

Change counter

Add to a counter document and return its new value; a negative amount subtracts. A starting value creates it when missing.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Document keykeytextRequired
The document's key (its unique id in the collection), up to 250 bytes.
Change bydeltanumberRequired
How much to add; use a negative number to subtract.
Start atinitialnumber
Create the counter with this value if it does not exist. Leave empty to fail instead.At least 0.

Outputs

keytext
The counter's key
valuenumber
The counter's new value
Example output
{
  "key": "visits",
  "value": 8
}

Create bucket

Create a bucket, the top-level container for data. The result includes its id. On a free tier cluster only name and memory apply.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
NamenametextRequired
The bucket's name: letters, digits and _ . % -, up to 100.
Memory (MiB)memory_mbnumber
Memory for the bucket, at least 100. Leave empty for Capella's default.At least 100.
Typebucket_typetext
Couchbase buckets are stored on disk; ephemeral ones live in memory only.One of: couchbase (Couchbase (default)), ephemeral (Ephemeral (memory only)).
Storage enginestorage_backendtext
How a Couchbase bucket is stored. Leave empty for Capella's default.One of: couchstore, magma.
Conflict resolutionconflict_resolutiontext
Which copy wins when two clusters change the same document.One of: seqno (Sequence number (default)), lww (Last write wins).
Durabilitydurability_leveltext
How many copies must confirm a write before it counts.One of: none (None (default)), majority, majorityAndPersistActive (Majority and persist on active), persistToMajority (Persist to majority).
Replicasreplicastext
How many extra copies of the data to keep, 1 to 3.One of: 1 (1 replica (default)), 2 (2 replicas), 3 (3 replicas).
Allow flushingflush_enabledtrue/false
Whether every document in the bucket can be erased at once from Capella.
Document lifetime (seconds)time_to_live_secondsnumber
Delete documents this long after they are written. 0 keeps them for ever.At least 0.
Evictioneviction_policytext
What to do when memory is full.One of: fullEviction (Full eviction (default)), noEviction (No eviction), nruEviction (Not-recently-used eviction).

Outputs

bucketobject
The new bucket
bucket_idtext
The new bucket's id
Example output
{
  "bucket": {
    "bucketConflictResolution": "seqno",
    "durabilityLevel": "none",
    "evictionPolicy": "fullEviction",
    "flushEnabled": false,
    "id": "b3JkZXJz",
    "memoryAllocationInMb": 100,
    "name": "orders",
    "replicas": 1,
    "stats": {
      "diskUsedInMib": 12,
      "itemCount": 1200,
      "memoryUsedInMib": 40,
      "opsPerSecond": 3
    },
    "storageBackend": "couchstore",
    "timeToLiveInSeconds": 0,
    "type": "couchbase"
  },
  "bucket_id": "b3JkZXJz"
}

Create collection

Create a collection in a scope, the place documents are stored (like a table).

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scopescope_nametextRequired
The scope in that bucket.
Collection namecollection_nametextRequired
Letters, digits and _ - %, up to 251, not starting with _ or %.
Document lifetime (seconds)max_ttl_secondsnumber
Delete documents this long after they are written. 0 uses the bucket's setting, -1 never deletes them (Couchbase Server 7.6 and later).At least -1.

Outputs

collectionobject
The new collection
collection_nametext
The new collection's name
Example output
{
  "collection": {
    "maxTTL": 0,
    "name": "invoices"
  },
  "collection_name": "invoices"
}

Create document

Add a new document under a key. It fails if the key is already used; use Update document to replace one.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Document keykeytextRequired
The document's key (its unique id in the collection), up to 250 bytes.
DocumentdocumentobjectRequired
The document's content, as fields and values.

Outputs

castext
The document's version (CAS)
createdtrue/false
Always true once created
keytext
The document's key
Example output
{
  "cas": "1700000000000",
  "created": true,
  "key": "order::1001"
}

Create project

Create an empty project to group clusters. The result includes its id.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
NamenametextRequired
The project's name, up to 128 characters.
Descriptiondescriptiontext
A short description, up to 256 characters.

Outputs

projectobject
The new project
project_idtext
The new project's id
Example output
{
  "project": {
    "audit": {
      "createdAt": "2026-10-15T09:00:00Z",
      "createdBy": "user-id",
      "modifiedAt": "2026-10-15T09:00:00Z",
      "modifiedBy": "user-id",
      "version": 1
    },
    "description": "Orders and customers",
    "id": "ffffffff-aaaa-1414-eeee-000000000001",
    "name": "Customer data"
  },
  "project_id": "ffffffff-aaaa-1414-eeee-000000000001"
}

Create scope

Create a scope in a bucket, a named group of collections.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scope namescope_nametextRequired
Letters, digits and _ - %, up to 251, not starting with _ or %.

Outputs

scopeobject
The new scope
scope_nametext
The new scope's name
Example output
{
  "scope": {
    "collections": [
      {
        "maxTTL": 0,
        "name": "invoices"
      }
    ],
    "name": "sales"
  },
  "scope_name": "sales"
}

Delete allowed address

Stop allowing an IP address or range to connect to a cluster.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Allowed addressallowed_cidr_idtextRequired
The allowed IP address or range on that cluster.

Outputs

allowed_cidr_idtext
The entry deleted
deletedtrue/false
Always true once deleted
Example output
{
  "allowed_cidr_id": "cidr-0001",
  "deleted": true
}

Delete bucket

Delete a bucket and every scope, collection and document in it. This cannot be undone.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.

Outputs

bucket_idtext
The bucket deleted
deletedtrue/false
Always true once deleted
Example output
{
  "bucket_id": "b3JkZXJz",
  "deleted": true
}

Delete collection

Delete a collection and every document in it. This cannot be undone.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scopescope_nametextRequired
The scope in that bucket.
Collectioncollection_nametextRequired
The collection in that scope.

Outputs

collection_nametext
The collection deleted
deletedtrue/false
Always true once deleted
Example output
{
  "collection_name": "invoices",
  "deleted": true
}

Delete document

Delete a document by its key.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Document keykeytextRequired
The document's key (its unique id in the collection), up to 250 bytes.

Outputs

castext
The deleted document's version (CAS)
deletedtrue/false
Always true once deleted
keytext
The document's key
Example output
{
  "cas": "1700000000002",
  "deleted": true,
  "key": "order::1001"
}

Delete project

Delete a project. Capella refuses while the project still has clusters.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.

Outputs

deletedtrue/false
Always true once deleted
project_idtext
The project deleted
Example output
{
  "deleted": true,
  "project_id": "ffffffff-aaaa-1414-eeee-000000000001"
}

Delete scope

Delete a scope with all its collections and documents. This cannot be undone.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scopescope_nametextRequired
The scope in that bucket.

Outputs

deletedtrue/false
Always true once deleted
scope_nametext
The scope deleted
Example output
{
  "deleted": true,
  "scope_name": "sales"
}

Find documents

Find the documents in a collection whose field matches a value, with optional sorting. No SQL++ needed; the collection needs an index.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Fieldfield_nametext
Only documents whose field matches. Use address.city for a nested field. Leave empty for all.
Comparisonoperatortext
How the field is compared with the value. Defaults to equals.One of: equals (Equals (default)), not_equals (Does not equal), greater_than (Greater than), greater_or_equal (Greater than or equal to), less_than (Less than), less_or_equal (Less than or equal to), contains (Contains (text)), starts_with (Starts with (text)).
Valuevaluetext
The value to compare the field with. Needed when a field is given.
Sort bysort_fieldtext
A field to sort the documents by. Leave empty for no order.
Sort ordersort_directiontext
Used with Sort by. Defaults to ascending.One of: asc (Ascending (default)), desc (Descending).
Most documentslimitnumber
How many documents to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many matched
documentslist
Each match, as its key (id) and content (document)
statementtext
The SQL++ that was run
Example output
{
  "count": 1,
  "documents": [
    {
      "document": {
        "status": "paid"
      },
      "id": "order::1001"
    }
  ],
  "statement": "SELECT META(d).id AS id, d AS document FROM `orders`.`_default`.`_default` AS d LIMIT 100"
}

Get bucket

Get one bucket's settings and statistics.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.

Outputs

bucketobject
The bucket
Example output
{
  "bucket": {
    "bucketConflictResolution": "seqno",
    "durabilityLevel": "none",
    "evictionPolicy": "fullEviction",
    "flushEnabled": false,
    "id": "b3JkZXJz",
    "memoryAllocationInMb": 100,
    "name": "orders",
    "replicas": 1,
    "stats": {
      "diskUsedInMib": 12,
      "itemCount": 1200,
      "memoryUsedInMib": 40,
      "opsPerSecond": 3
    },
    "storageBackend": "couchstore",
    "timeToLiveInSeconds": 0,
    "type": "couchbase"
  }
}

Get cluster

Get one cluster: its state, cloud and region, Couchbase version and connection string.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.

Outputs

clusterobject
The cluster
Example output
{
  "cluster": {
    "audit": {
      "createdAt": "2026-10-15T09:00:00Z",
      "createdBy": "user-id",
      "modifiedAt": "2026-10-15T09:00:00Z",
      "modifiedBy": "user-id",
      "version": 1
    },
    "availability": {
      "type": "multi"
    },
    "cloudProvider": {
      "cidr": "10.0.0.0/20",
      "region": "us-east-1",
      "type": "aws"
    },
    "configurationType": "multiNode",
    "connectionString": "cb.example.cloud.couchbase.com",
    "couchbaseServer": {
      "version": "7.6"
    },
    "currentState": "healthy",
    "deletionProtection": false,
    "description": "",
    "id": "ffffffff-aaaa-1414-eeee-000000000002",
    "name": "prod",
    "support": {
      "plan": "developer pro",
      "timezone": "PT"
    }
  }
}

Get document

Read one document by its key. Needs the Data API details in the connection.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Document keykeytextRequired
The document's key (its unique id in the collection), up to 250 bytes.

Outputs

castext
The document's version (CAS), changes with every write
documentobject
The document's content
keytext
The document's key
Example output
{
  "cas": "1700000000000",
  "document": {
    "total": 42
  },
  "key": "order::1001"
}

Get project

Get one project with its name, description and who last changed it.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.

Outputs

projectobject
The project
Example output
{
  "project": {
    "audit": {
      "createdAt": "2026-10-15T09:00:00Z",
      "createdBy": "user-id",
      "modifiedAt": "2026-10-15T09:00:00Z",
      "modifiedBy": "user-id",
      "version": 1
    },
    "description": "Orders and customers",
    "id": "ffffffff-aaaa-1414-eeee-000000000001",
    "name": "Customer data"
  }
}

List allowed addresses

List the IP addresses and ranges allowed to connect to a cluster.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Pagepagenumber
Which page to get, starting at 1. Capella's default is 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Capella's default is 10.From 1 to 100.

Outputs

allowed_cidrslist
The addresses on this page
countnumber
How many on this page
has_moretrue/false
Whether another page follows
last_pagenumber
The number of the last page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
This page's number
per_pagenumber
The page size used
total_itemsnumber
How many there are in all
Example output
{
  "allowed_cidrs": [
    {
      "audit": {
        "createdAt": "2026-10-15T09:00:00Z",
        "createdBy": "user-id",
        "modifiedAt": "2026-10-15T09:00:00Z",
        "modifiedBy": "user-id",
        "version": 1
      },
      "cidr": "203.0.113.0/24",
      "comment": "Office",
      "expiresAt": "",
      "id": "cidr-0001",
      "status": "active",
      "type": "permanent"
    }
  ],
  "count": 1,
  "has_more": false,
  "last_page": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 10,
  "total_items": 1
}

List buckets

List a cluster's buckets with their settings, item counts and memory use.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.

Outputs

bucketslist
The buckets
cluster_statsobject
Free and total memory on the cluster
countnumber
How many
Example output
{
  "buckets": [
    {
      "bucketConflictResolution": "seqno",
      "durabilityLevel": "none",
      "evictionPolicy": "fullEviction",
      "flushEnabled": false,
      "id": "b3JkZXJz",
      "memoryAllocationInMb": 100,
      "name": "orders",
      "replicas": 1,
      "stats": {
        "diskUsedInMib": 12,
        "itemCount": 1200,
        "memoryUsedInMib": 40,
        "opsPerSecond": 3
      },
      "storageBackend": "couchstore",
      "timeToLiveInSeconds": 0,
      "type": "couchbase"
    }
  ],
  "cluster_stats": {
    "freeMemoryInMb": 800,
    "maxReplicas": 2,
    "totalMemoryInMb": 1000
  },
  "count": 1
}

List clusters

List a project's database clusters with their state, cloud and connection string.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Pagepagenumber
Which page to get, starting at 1. Capella's default is 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Capella's default is 10.From 1 to 100.

Outputs

clusterslist
The clusters on this page
countnumber
How many on this page
has_moretrue/false
Whether another page follows
last_pagenumber
The number of the last page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
This page's number
per_pagenumber
The page size used
total_itemsnumber
How many there are in all
Example output
{
  "clusters": [
    {
      "audit": {
        "createdAt": "2026-10-15T09:00:00Z",
        "createdBy": "user-id",
        "modifiedAt": "2026-10-15T09:00:00Z",
        "modifiedBy": "user-id",
        "version": 1
      },
      "availability": {
        "type": "multi"
      },
      "cloudProvider": {
        "cidr": "10.0.0.0/20",
        "region": "us-east-1",
        "type": "aws"
      },
      "configurationType": "multiNode",
      "connectionString": "cb.example.cloud.couchbase.com",
      "couchbaseServer": {
        "version": "7.6"
      },
      "currentState": "healthy",
      "deletionProtection": false,
      "description": "",
      "id": "ffffffff-aaaa-1414-eeee-000000000002",
      "name": "prod",
      "support": {
        "plan": "developer pro",
        "timezone": "PT"
      }
    }
  ],
  "count": 1,
  "has_more": false,
  "last_page": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 10,
  "total_items": 1
}

List collections

List a scope's collections with their document lifetime.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scopescope_nametextRequired
The scope in that bucket.

Outputs

collectionslist
The collections
countnumber
How many
Example output
{
  "collections": [
    {
      "maxTTL": 0,
      "name": "invoices"
    }
  ],
  "count": 1
}

List organizations

List the Capella organizations the API key can see, with their ids.

Inputs

None.

Outputs

countnumber
How many
organizationslist
The organizations
Example output
{
  "count": 1,
  "organizations": [
    {
      "audit": {
        "createdAt": "2026-10-15T09:00:00Z",
        "createdBy": "user-id",
        "modifiedAt": "2026-10-15T09:00:00Z",
        "modifiedBy": "user-id",
        "version": 1
      },
      "description": "",
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "Acme",
      "subdomain": "acme"
    }
  ]
}

List projects

List an organization's projects, one page at a time.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Pagepagenumber
Which page to get, starting at 1. Capella's default is 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. Capella's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether another page follows
last_pagenumber
The number of the last page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
This page's number
per_pagenumber
The page size used
projectslist
The projects on this page
total_itemsnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "last_page": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 10,
  "projects": [
    {
      "audit": {
        "createdAt": "2026-10-15T09:00:00Z",
        "createdBy": "user-id",
        "modifiedAt": "2026-10-15T09:00:00Z",
        "modifiedBy": "user-id",
        "version": 1
      },
      "description": "Orders and customers",
      "id": "ffffffff-aaaa-1414-eeee-000000000001",
      "name": "Customer data"
    }
  ],
  "total_items": 1
}

List scopes

List a bucket's scopes, each with its collections.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.

Outputs

countnumber
How many
scopeslist
The scopes
Example output
{
  "count": 1,
  "scopes": [
    {
      "collections": [
        {
          "maxTTL": 0,
          "name": "invoices"
        }
      ],
      "name": "sales"
    }
  ]
}

Run SQL++ query

Run a SQL++ (N1QL) statement, such as a SELECT, an UPDATE or CREATE INDEX, and get its rows back.

Inputs

SQL++ statementstatementtextRequired
The statement to run, such as SELECT * FROM `orders`.`_default`.`_default` WHERE total > $min LIMIT 10. Use $name or $1 for values from Parameters.
Default bucketbuckettext
Let the statement name collections without the bucket.
Default scopescopetext
With a default bucket, the scope names are looked up in. Defaults to _default.
Parametersparametersobject
Values for the statement, as named values ({"min": 10} for $min) or a list for $1, $2. Passing values here avoids escaping them.
Only allow readsread_onlytrue/false
Refuse statements that change data or indexes.
Freshnessscan_consistencytext
Whether results must include writes made just before the query.One of: not_bounded (Fastest, may miss very recent writes (default)), request_plus (Include every write made before the query).
Time limit (seconds)timeout_secondsnumber
Stop the query after this long, 1 to 70.From 1 to 70.

Outputs

countnumber
How many rows
metricsobject
Timing, result count and mutation count
request_idtext
Capella's id for the request
resultslist
The rows the statement returned
statustext
The query's status, success when it worked
warningslist
Warnings from the query
Example output
{
  "count": 1,
  "metrics": {
    "elapsedTime": "3ms",
    "resultCount": 1
  },
  "request_id": "5f1d1c5a-0000-0000-0000-000000000000",
  "results": [
    {
      "one": 1
    }
  ],
  "status": "success",
  "warnings": []
}

Update bucket

Change a bucket's memory, durability, replicas, flush setting or document lifetime. Only the settings given change.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Memory (MiB)memory_mbnumber
A new memory size, at least 100. Leave empty to keep it.At least 100.
Durabilitydurability_leveltext
A new durability level. Leave empty to keep it.One of: none (None (default)), majority, majorityAndPersistActive (Majority and persist on active), persistToMajority (Persist to majority).
Replicasreplicastext
A new number of replicas. Leave empty to keep it.One of: 1 (1 replica (default)), 2 (2 replicas), 3 (3 replicas).
Allow flushingflush_enabledtrue/false
Turn flushing on or off. Leave unset to keep it.
Document lifetime (seconds)time_to_live_secondsnumber
A new lifetime for documents, 0 for none. Leave empty to keep it.At least 0.

Outputs

bucketobject
The bucket
Example output
{
  "bucket": {
    "bucketConflictResolution": "seqno",
    "durabilityLevel": "none",
    "evictionPolicy": "fullEviction",
    "flushEnabled": false,
    "id": "b3JkZXJz",
    "memoryAllocationInMb": 200,
    "name": "orders",
    "replicas": 1,
    "stats": {
      "diskUsedInMib": 12,
      "itemCount": 1200,
      "memoryUsedInMib": 40,
      "opsPerSecond": 3
    },
    "storageBackend": "couchstore",
    "timeToLiveInSeconds": 0,
    "type": "couchbase"
  }
}

Update collection

Change how long documents in a collection are kept before Capella deletes them.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Clustercluster_idtextRequired
The database cluster in that project.
Bucketbucket_idtextRequired
The bucket on that cluster. Pick one, or give the id from 'Create bucket'.
Scopescope_nametextRequired
The scope in that bucket.
Collectioncollection_nametextRequired
The collection in that scope.
Document lifetime (seconds)max_ttl_secondsnumberRequired
Delete documents this long after they are written. 0 uses the bucket's setting, -1 never deletes them (Couchbase Server 7.6 and later).At least -1.

Outputs

collectionobject
The collection
Example output
{
  "collection": {
    "maxTTL": 86400,
    "name": "invoices"
  }
}

Update document

Replace the whole content of an existing document. It fails if the key does not exist.

Inputs

BucketbuckettextRequired
The bucket's name, read from the cluster. Type it if it is not listed.
ScopescopetextRequired
The scope's name. Every bucket has one called _default.
CollectioncollectiontextRequired
The collection's name. Every scope has one called _default.
Document keykeytextRequired
The document's key (its unique id in the collection), up to 250 bytes.
DocumentdocumentobjectRequired
The document's content, as fields and values.

Outputs

castext
The document's new version (CAS)
keytext
The document's key
updatedtrue/false
Always true once updated
Example output
{
  "cas": "1700000000001",
  "key": "order::1001",
  "updated": true
}

Update project

Rename a project or change its description. Only the fields given change.

Inputs

Organizationorganization_idtextRequired
The Capella organization. Pick one, or give its id from an earlier step.
Projectproject_idtextRequired
The project in that organization.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.

Outputs

projectobject
The project
Example output
{
  "project": {
    "audit": {
      "createdAt": "2026-10-15T09:00:00Z",
      "createdBy": "user-id",
      "modifiedAt": "2026-10-15T09:00:00Z",
      "modifiedBy": "user-id",
      "version": 1
    },
    "description": "Orders and customers",
    "id": "ffffffff-aaaa-1414-eeee-000000000001",
    "name": "Customer data (live)"
  }
}

On this page