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 Search Indexes API

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

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

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

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

Requests are made against 2 base URLs: https://localhost:8094, https://localhost:18094.

7 operations 5 paths 3 schemas 1 DELETE2 GET3 POST1 PUT

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 Search Indexes 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 7

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

Search Indexes 7

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

GET
/api/index
List all search index definitions
listSearchIndexes → 200401
GET
/api/index/{indexName}
Get a search index definition
getSearchIndex 1 param → 200401404
PUT
/api/index/{indexName}
Create or update a search index
createOrUpdateSearchIndex 1 param body → 200400401
DELETE
/api/index/{indexName}
Delete a search index
deleteSearchIndex 1 param → 200401404
POST
/api/index/{indexName}/ingestControl/{operation}
Control search index data ingestion
controlSearchIndexIngest 2 params → 200401404
POST
/api/index/{indexName}/queryControl/{operation}
Control search index query access
controlSearchIndexQuery 2 params → 200401404
POST
/api/index/{indexName}/planFreezeControl/{operation}
Control search index plan freeze
controlSearchIndexPlanFreeze 2 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SearchIndexDefinition (8 properties), SearchIndexResponse (2 properties), SearchIndexList (2 properties). Each schema is shown below with its type and property counts.

SearchIndexDefinition
object
Full Text Search index definition
8 properties 3 required
SearchIndexList
object
List of all search index definitions
2 properties
SearchIndexResponse
object
Single search index definition response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-search-indexes-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 Search Indexes 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.