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 Types API

The Types API from Riak KV — 7 operation(s) for types.

Riak KV Types 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 Types. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

14 operations 7 paths 0 schemas 2 DELETE7 GET3 POST2 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 Types 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 14

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

Types 14
GET
/types/{type}/buckets
List buckets in a bucket type
listBuckets 2 params → 200
GET
/types/{type}/buckets/{bucket}/props
Get bucket properties
getBucketProps 2 params → 200
PUT
/types/{type}/buckets/{bucket}/props
Set bucket properties
setBucketProps 2 params body → 204
DELETE
/types/{type}/buckets/{bucket}/props
Reset bucket properties to defaults
resetBucketProps 2 params → 204
GET
/types/{type}/buckets/{bucket}/keys
List keys in a bucket
listKeys 3 params → 200
POST
/types/{type}/buckets/{bucket}/keys
Store an object with a server-generated key
storeObjectAutoKey 2 params body → 201
GET
/types/{type}/buckets/{bucket}/keys/{key}
Fetch an object
fetchObject 3 params → 200404300
PUT
/types/{type}/buckets/{bucket}/keys/{key}
Store an object
storeObject 3 params body → 200204
POST
/types/{type}/buckets/{bucket}/keys/{key}
Store an object (alias for PUT with auto vector clock handling)
postObject 3 params body → 204
DELETE
/types/{type}/buckets/{bucket}/keys/{key}
Delete an object
deleteObject 3 params → 204404
GET
/types/{type}/buckets/{bucket}/index/{index}/{value}
Secondary index exact-match query
secondaryIndexQuery 4 params → 200
GET
/types/{type}/buckets/{bucket}/index/{index}/{start}/{end}
Secondary index range query
secondaryIndexRange 5 params → 200
GET
/types/{type}/buckets/{bucket}/datatypes/{key}
Fetch a CRDT data type (counter, set, map, hll)
fetchDataType 3 params → 200
POST
/types/{type}/buckets/{bucket}/datatypes/{key}
Update a CRDT data type
updateDataType 3 params body → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

riak-types-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 Search API
Riak KV Stats API