How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Couchbase Query Admin API

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

Couchbase Query Admin API is one of 54 APIs that Couchbase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Query Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 7 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 7.6.

Requests are made against 2 base URLs: https://localhost:8093, https://localhost:18093.

9 operations 7 paths 4 schemas 2 DELETE7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
7.6
Base URL
https://localhost:8091
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Couchbase Query Admin API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Couchbase Server credentials.

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 2 DELETE, 7 GET. Each is listed below with its method, path, parameters, and response codes.

Query Admin 9

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

GET
/admin/active_requests
List active query requests
listActiveRequests → 200401
GET
/admin/active_requests/{requestId}
Get an active request
getActiveRequest 1 param → 200401404
DELETE
/admin/active_requests/{requestId}
Cancel an active request
cancelActiveRequest 1 param → 200401404
GET
/admin/completed_requests
List completed query requests
listCompletedRequests → 200401
GET
/admin/prepareds
List prepared statements
listPreparedStatements → 200401
GET
/admin/prepareds/{name}
Get a prepared statement
getPreparedStatement 1 param → 200401404
DELETE
/admin/prepareds/{name}
Delete a prepared statement
deletePreparedStatement 1 param → 200401404
GET
/admin/indexes/active_requests
List active index requests
listActiveIndexRequests → 200401
GET
/admin/vitals
Get query service vitals
getQueryVitals → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are QueryVitals (15 properties), CompletedRequest (8 properties), ActiveRequest (8 properties), PreparedStatement (4 properties). Each schema is shown below with its type and property counts.

ActiveRequest
object
An active query request
8 properties
QueryVitals
object
Query service vital statistics
15 properties
PreparedStatement
object
A cached prepared statement
4 properties
CompletedRequest
object
A completed query request
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-query-admin-api-openapi.yml Raw ↑

Other APIs Couchbase publishes across the network.

Couchbase Allowed CIDRs API
Couchbase Analytics Admin API
Couchbase Analytics Configuration API
Couchbase Analytics Library API
Couchbase Analytics Query API
Couchbase Analytics Settings API
Couchbase API Keys API
Couchbase Authentication API
Couchbase Buckets API
Couchbase Changes API
Couchbase Cluster API
Couchbase Cluster References API
Where this information came from

This is an independent, third-party profile of Couchbase Query Admin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.