Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Riak KV Search API

The Search API from Riak KV — 4 operation(s) for search.

Riak KV Search API is one of 8 APIs that Riak KV publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 2.2.

Requests are made against a single base URL, http://{host}:{port}.

7 operations 4 paths 0 schemas 1 DELETE4 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.2
Base URL
http://:8098
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Riak KV Search API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

  • BasicAuth — Riak KV supports optional security with HTTPS and basic auth or certificate-based authentication. By default, the HTTP listener is unauthenticated.

Paths & Operations 7

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

Search 7
GET
/search/query/{index_name}
Execute a Riak Search (Solr) query
searchQuery 3 params → 200
GET
/search/index
List all search indexes
listSearchIndexes → 200
GET
/search/index/{index_name}
Get a search index definition
getSearchIndex 1 param → 200404
PUT
/search/index/{index_name}
Create or update a search index
putSearchIndex 1 param body → 204
DELETE
/search/index/{index_name}
Delete a search index
deleteSearchIndex 1 param → 204
GET
/search/schema/{schema_name}
Get a search schema
getSearchSchema 1 param → 200
PUT
/search/schema/{schema_name}
Store a search schema
putSearchSchema 1 param body → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

riak-search-api-openapi.yml Raw ↑

Other APIs Riak KV publishes across the network.

Riak KV HTTP API
Riak Protocol Buffers Client API
Riak KV Mapred API
Riak KV Ping API
Riak KV Riak KV HTTP API API
Riak KV Stats API
Riak KV Types API