Skip to content

api-evangelist/couchbase

Repository files navigation

Couchbase (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.

APIs.json: https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/apis.yml

Scope

  • Type: Index
  • Position: Provider
  • Access: Public

Tags

  • Analytics
  • App Services
  • Backup
  • Capella
  • Cloud
  • Database
  • DBaaS
  • Eventing
  • Full-Text Search
  • Gateway
  • JSON
  • Mobile
  • NoSQL
  • Replication
  • SQL++
  • Sync
  • Vector Search
  • XDCR

Timestamps

  • Created: 2025-03-01
  • Modified: 2026-05-19

APIs

Couchbase Server REST API

The Couchbase Server REST API provides programmatic access to manage and configure Couchbase Server clusters. It includes endpoints for cluster management, bucket operations, node administration, security settings, and server configuration. The API enables automation of deployment, monitoring, and maintenance tasks for Couchbase Server instances across distributed environments.

Tags

  • Administration
  • Buckets
  • Clusters
  • Database
  • NoSQL

Properties

Couchbase Query Service REST API

The Couchbase Query Service REST API enables developers to execute SQL++ (formerly N1QL) queries against Couchbase Server and manage query service settings. It supports ad-hoc queries, prepared statements, and request-level parameter configuration. The API provides endpoints for query execution, monitoring active requests, and managing query service configuration across cluster nodes.

Tags

  • Database
  • N1QL
  • NoSQL
  • Query
  • SQL++

Properties

Couchbase Analytics Service REST API

The Couchbase Analytics Service REST API provides access to the Analytics service for running complex analytical queries on operational data without impacting performance of key-value operations. It supports SQL++ queries for analytics, management of links to external data sources, and configuration of user-defined libraries. The service enables real-time analytics on JSON data alongside transactional workloads.

Tags

  • Analytics
  • Database
  • NoSQL
  • SQL++

Properties

Couchbase Search Service REST API

The Couchbase Search Service REST API allows developers to create, manage, and query Full Text Indexes on Couchbase Server. It supports full-text search queries with features like fuzzy matching, faceted search, highlighting, and geospatial queries. The API provides endpoints for index definition, index management, and executing search queries across JSON documents stored in Couchbase buckets.

Tags

  • Database
  • Full-Text Search
  • Indexing
  • NoSQL
  • Vector Search

Properties

Couchbase Eventing Service REST API

The Couchbase Eventing Service REST API provides methods for deploying and managing Eventing Functions that respond to data changes in real time. Eventing Functions allow developers to write server-side JavaScript logic triggered by document mutations, timers, or external events.

Tags

  • Database
  • Eventing
  • NoSQL
  • Serverless Functions

Properties

Couchbase Backup Service REST API

The Couchbase Backup Service REST API supports management of the Backup Service for Couchbase Server, providing endpoints for cluster configuration, repository management, backup plans, task scheduling, and data operations.

Tags

  • Backup
  • Database
  • Disaster Recovery
  • NoSQL

Properties

Couchbase XDCR REST API

The Couchbase XDCR (Cross Data Center Replication) REST API enables configuration and management of data replication between Couchbase clusters across different data centers. It provides endpoints for creating replication references, configuring replication streams, monitoring replication statistics, and managing replication settings.

Tags

  • Cross Data Center
  • Database
  • NoSQL
  • Replication

Properties

Couchbase Capella Management API

The Couchbase Capella Management API is a REST API for provisioning, deploying, and configuring Couchbase Capella database-as-a-service deployments across AWS, Azure, and Google Cloud. It enables programmatic management of clusters, buckets, users, and organizations using API key authentication.

Tags

  • Capella
  • Cloud
  • Database
  • DBaaS
  • Management
  • NoSQL

Properties

Couchbase Capella App Services Public API

The Couchbase Capella App Services Public API provides REST endpoints for mobile and edge application data synchronization with Couchbase Capella. It enables developers to manage document access, handle user authentication, and synchronize data between mobile devices and the cloud database.

Tags

  • App Services
  • Capella
  • Cloud
  • Mobile
  • NoSQL
  • Sync

Properties

Couchbase Capella App Services Admin API

The Couchbase Capella App Services Admin API provides administrative REST endpoints for managing Sync Gateway configurations within Couchbase Capella. It enables administrators to manage databases, users, roles, sync functions, and replication settings for mobile data synchronization.

Tags

  • Administration
  • App Services
  • Capella
  • Cloud
  • Mobile
  • NoSQL

Properties

Couchbase Sync Gateway Public REST API

The Couchbase Sync Gateway Public REST API provides endpoints for mobile and edge clients to synchronize data with Couchbase Server through the Sync Gateway middleware. It supports document CRUD operations, changes feeds for real-time data synchronization, and user authentication.

Tags

  • Database
  • Gateway
  • Mobile
  • NoSQL
  • Sync

Properties

Couchbase Sync Gateway Admin REST API

The Couchbase Sync Gateway Admin REST API provides administrative endpoints for configuring and managing Sync Gateway instances. It supports database management, user and role administration, sync function configuration, and replication setup.

Tags

  • Administration
  • Database
  • Mobile
  • NoSQL
  • Sync

Properties

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

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.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors