Couchbase website screenshot

Couchbase

Couchbase is a distributed, document-oriented NoSQL cloud database platform that combines the flexibility of JSON, the power of SQL++ querying, and the performance of an in-memory key-value store. The Couchbase product line includes Couchbase Server (self-managed), Couchbase Capella (fully managed database-as-a-service across AWS, Azure, and Google Cloud), Sync Gateway and App Services for mobile and edge synchronization, and Couchbase Lite embedded databases. Couchbase exposes a comprehensive set of REST APIs covering cluster administration, SQL++ query execution, full-text and vector search, analytics, eventing, backup, cross data center replication, and Capella management.

Couchbase publishes 54 APIs on the APIs.io network, including Allowed CIDRs API, Analytics Admin API, Analytics Configuration API, and 51 more. Tagged areas include Analytics, App Services, Backup, Capella, and Cloud.

The Couchbase catalog on APIs.io includes 1 JSON-LD context and 6 Spectral governance rulesets.

Couchbase’s developer surface includes authentication, documentation, pricing, engineering blog, support, changelog, and 19 more developer resources.

56.1/100 strong ▬ flat Agent 31/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemiumSelf serve⚡ Free to try
54 APIs 16 Features
AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 56.1/100 · strong
Contract Quality 15.5 / 25
Developer Ergonomics 5.2 / 20
Commercial Clarity 16.8 / 20
Operational Transparency 8.9 / 13
Governance 3.8 / 12
Discoverability 5.9 / 10
Agent readiness — 31/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/couchbase: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 54

Individual APIs this provider publishes, each with its own machine-readable definition.

Couchbase Allowed CIDRs API

Endpoints for managing allowed IP addresses and CIDR ranges for cluster access.

Couchbase Analytics Admin API

Endpoints for administering and monitoring the Analytics service.

Couchbase Analytics Configuration API

Endpoints for configuring Analytics nodes and clusters.

Couchbase Analytics Library API

Endpoints for managing JavaScript libraries used for user-defined functions.

Couchbase Analytics Query API

Endpoints for executing SQL++ analytics queries and retrieving results.

Couchbase Analytics Settings API

Endpoints for configuring Analytics service settings.

Couchbase API Keys API

Endpoints for managing API keys used to authenticate with the Management API.

Couchbase Authentication API

Endpoints for user authentication and session management.

Couchbase Buckets API

Endpoints for managing buckets within Capella clusters.

Couchbase Changes API

Endpoints for monitoring document changes and subscribing to change feeds.

Couchbase Cluster API

Endpoints for managing cluster-level backup configuration.

Couchbase Cluster References API

Endpoints for managing remote cluster references used as XDCR targets.

Couchbase Clusters API

Endpoints for provisioning, managing, and scaling Capella database clusters.

Couchbase Compaction API

Endpoints for managing auto-compaction settings and triggering compaction operations.

Couchbase Configuration API

Endpoints for configuring Eventing Service settings.

Couchbase Data API

Endpoints for triggering backup and restore data operations.

Couchbase Database Administration API

Endpoints for managing database configurations within App Services.

Couchbase Database API

Endpoints for retrieving database information.

Couchbase Database Credentials API

Endpoints for managing database access credentials for clusters.

Couchbase Database Management API

Endpoints for creating, configuring, and managing databases.

Couchbase Documents API

Endpoints for creating, reading, updating, and deleting documents.

Couchbase Functions API

Endpoints for creating, retrieving, updating, and deleting Eventing Functions.

Couchbase Import Export API

Endpoints for importing and exporting Eventing Function definitions.

Couchbase Index Service API

Endpoints for managing the Global Secondary Index service.

Couchbase Lifecycle API

Endpoints for deploying, undeploying, pausing, and resuming Eventing Functions.

Couchbase Local Documents API

Endpoints for managing local documents used by replication checkpoints.

Couchbase Logging API

Endpoints for retrieving Eventing Function application logs.

Couchbase Logs API

Endpoints for collecting and managing diagnostic logs.

Couchbase Monitoring API

Endpoints for monitoring App Services health and performance.

Couchbase Nodes API

Endpoints for managing individual server nodes, including adding nodes, failover, recovery, and rebalance operations.

Couchbase Organizations API

Endpoints for managing Capella organizations.

Couchbase Plans API

Endpoints for managing backup plans that define backup schedules and data retention policies.

Couchbase Projects API

Endpoints for creating, listing, updating, and deleting projects within an organization.

Couchbase Query Admin API

Endpoints for administrative operations on the Query service including monitoring active requests, completed requests, and prepared statements.

Couchbase Query Execution API

Endpoints for executing SQL++ queries and managing query results.

Couchbase Query Settings API

Endpoints for configuring Query service settings at the node and cluster level.

Couchbase Replication API

Endpoints for managing inter-Sync Gateway replications.

Couchbase Replication Settings API

Endpoints for configuring replication-level and global XDCR settings.

Couchbase Replication Statistics API

Endpoints for monitoring replication progress and performance statistics.

Couchbase Replications API

Endpoints for creating, managing, and deleting XDCR replication streams.

Couchbase Repositories API

Endpoints for creating, managing, and querying backup repositories.

Couchbase Role Management API

Endpoints for managing roles and their channel assignments.

Couchbase Scopes and Collections API

Endpoints for managing scopes and collections within Capella buckets.

Couchbase Search Indexes API

Endpoints for creating, retrieving, updating, and deleting Full Text Search index definitions.

Couchbase Search Monitoring API

Endpoints for monitoring search index statistics and service status.

Couchbase Search Queries API

Endpoints for executing full-text search queries against search indexes.

Couchbase Security API

Endpoints for managing security settings, users, roles, certificates, and audit configurations.

Couchbase Server API

Endpoints for managing the Sync Gateway server instance.

Couchbase Server Groups API

Endpoints for managing server groups for rack-zone awareness.

Couchbase Settings API

Endpoints for managing server-wide settings and configuration parameters.

Couchbase Statistics API

Endpoints for monitoring Eventing Function execution statistics and status.

Couchbase Tasks API

Endpoints for monitoring and managing backup and restore tasks.

Couchbase User Management API

Endpoints for managing users and their access permissions.

Couchbase Users API

Endpoints for managing users within a Capella organization.

Scroll for all 54

Open Collections 12

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Couchbase Server REST API

OPEN COLLECTION

Couchbase XDCR REST API

OPEN COLLECTION

Scroll for all 12

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Couchbase Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Features 16

Notable capabilities this provider offers.

Free: 1 node, 8 GB capacity
Basic from $0.15/hr/node: single AZ, 24h backup
Developer Pro from $0.35/hr/node: multi-AZ 3 nodes, 99.99% SLA
Enterprise from $0.49/hr/node: CMEK, 30-min response
Backup: $0.06-$0.07/GB monthly
Data transfer fees typically <10% of billing
SQL++ (N1QL) query language
Full-text search built-in
Mobile sync via Sync Gateway
Multi-cloud: AWS, GCP, Azure
Management API: 600 req/min/org
App Services for embedded apps
Eventing service for triggers
Analytics service for ad-hoc queries
Multi-document ACID transactions
Built-in caching (Memcached compatible)

Scroll for all 16

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Couchbase Context

0 classes · 14 properties

JSON-LD

Spectral Rules 6

Spectral governance rulesets for linting and validating these APIs.

Couchbase API Rules

5 rules · 3 errors 2 warnings

SPECTRAL

Couchbase API Rules

6 rules · 4 warnings 2 info

SPECTRAL

Couchbase API Rules

4 rules · 3 errors 1 warnings

SPECTRAL

Couchbase API Rules

4 rules · 3 errors 1 warnings

SPECTRAL

Couchbase API Rules

5 rules · 4 errors 1 warnings

SPECTRAL

Couchbase API Rules

4 rules · 3 errors 1 warnings

SPECTRAL

JSON Schema 78

Standalone JSON Schema definitions for this provider's data models.

ActiveRequest

8 properties

JSON SCHEMA

AllDocsResponse

3 properties

JSON SCHEMA

AllowedCIDR

6 properties

JSON SCHEMA

AllowedCIDRCreateRequest

3 properties

JSON SCHEMA

AnalyticsClusterStatus

2 properties

JSON SCHEMA

AnalyticsNodeConfig

3 properties

JSON SCHEMA

AnalyticsQueryRequest

7 properties

JSON SCHEMA

AnalyticsQueryResult

7 properties

JSON SCHEMA

AnalyticsServiceConfig

9 properties

JSON SCHEMA

AnalyticsSettings

1 properties

JSON SCHEMA

ApiKeyCreateRequest

6 properties

JSON SCHEMA

ApiKeyCreateResponse

2 properties

JSON SCHEMA

AuditInfo

5 properties

JSON SCHEMA

AutoCompactionSettings

3 properties

JSON SCHEMA

BackupClusterInfo

3 properties

JSON SCHEMA

BackupPlan

5 properties

JSON SCHEMA

BackupRepository

6 properties

JSON SCHEMA

BackupRepositoryCreateRequest

3 properties

JSON SCHEMA

BackupTask

6 properties

JSON SCHEMA

Couchbase Bucket Configuration

13 properties

JSON SCHEMA

BucketCreateRequest

7 properties

JSON SCHEMA

BucketUpdateRequest

3 properties

JSON SCHEMA

CapellaBucket

10 properties

JSON SCHEMA

CapellaBucketCreateRequest

8 properties

JSON SCHEMA

CapellaBucketUpdateRequest

5 properties

JSON SCHEMA

CapellaScope

2 properties

JSON SCHEMA

ChangesResponse

3 properties

JSON SCHEMA

Couchbase Cluster Configuration

7 properties

JSON SCHEMA

ClusterCreateRequest

7 properties

JSON SCHEMA

ClusterUpdateRequest

4 properties

JSON SCHEMA

CompletedRequest

8 properties

JSON SCHEMA

DatabaseConfig

9 properties

JSON SCHEMA

DatabaseCredential

4 properties

JSON SCHEMA

DatabaseCredentialCreateRequest

3 properties

JSON SCHEMA

DatabaseInfo

6 properties

JSON SCHEMA

Couchbase Document

6 properties

JSON SCHEMA

DocumentResponse

3 properties

JSON SCHEMA

DocumentWriteResponse

3 properties

JSON SCHEMA

EventingConfig

2 properties

JSON SCHEMA

EventingFunction

5 properties

JSON SCHEMA

EventingFunctionStats

3 properties

JSON SCHEMA

EventingStatus

2 properties

JSON SCHEMA

IndexSettings

5 properties

JSON SCHEMA

Node

8 properties

JSON SCHEMA

NodesInfo

1 properties

JSON SCHEMA

Organization

5 properties

JSON SCHEMA

PaginatedResponse

2 properties

JSON SCHEMA

PoolDetails

5 properties

JSON SCHEMA

Pools

6 properties

JSON SCHEMA

PreparedStatement

4 properties

JSON SCHEMA

Project

4 properties

JSON SCHEMA

ProjectCreateRequest

2 properties

JSON SCHEMA

QueryRequest

10 properties

JSON SCHEMA

QueryResult

8 properties

JSON SCHEMA

QuerySettings

12 properties

JSON SCHEMA

QueryVitals

15 properties

JSON SCHEMA

RemoteClusterCreateRequest

7 properties

JSON SCHEMA

RemoteClusterReference

8 properties

JSON SCHEMA

ReplicationConfig

11 properties

JSON SCHEMA

ReplicationCreateRequest

7 properties

JSON SCHEMA

ReplicationSettings

12 properties

JSON SCHEMA

RestoreRequest

8 properties

JSON SCHEMA

Role

4 properties

JSON SCHEMA

RoleConfig

2 properties

JSON SCHEMA

RoleInfo

3 properties

JSON SCHEMA

ScopesList

2 properties

JSON SCHEMA

SearchIndexDefinition

8 properties

JSON SCHEMA

SearchIndexList

2 properties

JSON SCHEMA

SearchIndexResponse

2 properties

JSON SCHEMA

SearchQueryRequest

9 properties

JSON SCHEMA

SearchQueryResult

6 properties

JSON SCHEMA

ServerGroups

1 properties

JSON SCHEMA

ServerStatus

4 properties

JSON SCHEMA

ServiceGroup

3 properties

JSON SCHEMA

SessionResponse

3 properties

JSON SCHEMA

User

4 properties

JSON SCHEMA

UserConfig

6 properties

JSON SCHEMA

UserInfo

7 properties

JSON SCHEMA

Scroll for all 78

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Couchbase Structure

0 properties

JSON STRUCTURE

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Couchbase Authentication

apiKey/http · 3 schemes

SECURITY

Couchbase Domain Security

TLSv1.3 · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Couchbase Agentic Access

219 operations · 117 acting · 9 human-in-the-loop

219 operations · 117 acting

AGENTIC

Resources

Get Started 1

Portal, sign-up, and the first successful call

Documentation 4

Reference material describing how the API behaves

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 2

Authentication, authorization, and security posture

Operate 4

Status, limits, changes, and where to get help

Commercial 3

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Other 3

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: couchbase
name: Couchbase
kind: company
description: Couchbase is a distributed, document-oriented NoSQL cloud database platform that combines the flexibility of
  JSON, the power of SQL++ querying, and the performance of an in-memory key-value store. The Couchbase product line includes
  Couchbase Server (self-managed), Couchbase Capella (fully managed database-as-a-service across AWS, Azure, and Google Cloud),
  Sync Gateway and App Services for mobile and edge synchronization, and Couchbase Lite embedded databases. Couchbase exposes
  a comprehensive set of REST APIs covering cluster administration, SQL++ query execution, full-text and vector search, analytics,
  eventing, backup, cross data center replication, and Capella management.
url: https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/apis.yml
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/couchbase.png
type: Index
access: Public
position: Provider
tags:
- Analytics
- App Services
- Backup
- Capella
- Cloud
- Database
- DBaaS
- Eventing
- Full-Text Search
- Gateway
- JSON
- Mobile
- NoSQL
- Replication
- SQL++
- Sync
- Vector Search
- XDCR
created: '2025-03-01'
modified: '2026-05-19'
specificationVersion: '0.20'
apis:
- aid: couchbase:couchbase-allowed-cidrs-api
  name: Couchbase Allowed CIDRs API
  description: Endpoints for managing allowed IP addresses and CIDR ranges for cluster access.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Allowed CIDRs
  properties:
  - type: OpenAPI
    url: openapi/couchbase-allowed-cidrs-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-analytics-admin-api
  name: Couchbase Analytics Admin API
  description: Endpoints for administering and monitoring the Analytics service.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Analytics Admin
  properties:
  - type: OpenAPI
    url: openapi/couchbase-analytics-admin-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-analytics-configuration-api
  name: Couchbase Analytics Configuration API
  description: Endpoints for configuring Analytics nodes and clusters.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Analytics Configuration
  properties:
  - type: OpenAPI
    url: openapi/couchbase-analytics-configuration-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-analytics-library-api
  name: Couchbase Analytics Library API
  description: Endpoints for managing JavaScript libraries used for user-defined functions.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Analytics Library
  properties:
  - type: OpenAPI
    url: openapi/couchbase-analytics-library-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-analytics-query-api
  name: Couchbase Analytics Query API
  description: Endpoints for executing SQL++ analytics queries and retrieving results.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Analytics Query
  properties:
  - type: OpenAPI
    url: openapi/couchbase-analytics-query-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-analytics-settings-api
  name: Couchbase Analytics Settings API
  description: Endpoints for configuring Analytics service settings.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Analytics Settings
  properties:
  - type: OpenAPI
    url: openapi/couchbase-analytics-settings-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-api-keys-api
  name: Couchbase API Keys API
  description: Endpoints for managing API keys used to authenticate with the Management API.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/couchbase-api-keys-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-authentication-api
  name: Couchbase Authentication API
  description: Endpoints for user authentication and session management.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/couchbase-authentication-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-buckets-api
  name: Couchbase Buckets API
  description: Endpoints for managing buckets within Capella clusters.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Buckets
  properties:
  - type: OpenAPI
    url: openapi/couchbase-buckets-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-changes-api
  name: Couchbase Changes API
  description: Endpoints for monitoring document changes and subscribing to change feeds.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Changes
  properties:
  - type: OpenAPI
    url: openapi/couchbase-changes-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-cluster-api
  name: Couchbase Cluster API
  description: Endpoints for managing cluster-level backup configuration.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Cluster
  properties:
  - type: OpenAPI
    url: openapi/couchbase-cluster-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-cluster-references-api
  name: Couchbase Cluster References API
  description: Endpoints for managing remote cluster references used as XDCR targets.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Cluster References
  properties:
  - type: OpenAPI
    url: openapi/couchbase-cluster-references-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-clusters-api
  name: Couchbase Clusters API
  description: Endpoints for provisioning, managing, and scaling Capella database clusters.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Clusters
  properties:
  - type: OpenAPI
    url: openapi/couchbase-clusters-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html
  - type: Rules
    url: rules/couchbase-query-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-query-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html
  - type: Rules
    url: rules/couchbase-search-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-search-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/eventing/eventing-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/management-api-reference/index.html
  - type: Rules
    url: rules/couchbase-capella-management-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-capella-management-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html
  - type: Documentation
    url: https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
  - type: Rules
    url: rules/couchbase-sync-gateway-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-sync-gateway-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html
- aid: couchbase:couchbase-compaction-api
  name: Couchbase Compaction API
  description: Endpoints for managing auto-compaction settings and triggering compaction operations.
  humanURL: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  baseURL: https://localhost:8091
  tags:
  - Compaction
  properties:
  - type: OpenAPI
    url: openapi/couchbase-compaction-api-openapi.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html
  - type: Rules
    url: rules/couchbase-server-rules.yml
  - type: Capabilities
    url: capabilities/couchbase-server-capabilities.yml
  - type: Documentation
    url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-a

# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/apis.yml