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

KVdb Keys API

Key-value operations within a bucket

KVdb Keys API is one of 3 APIs that KVdb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://kvdb.io.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://kvdb.io
Authentication
HTTP Basic, API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

KVdb Keys API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the query as secret_key (secretKeyQuery). By default, every request must be authenticated.

  • basicAuth — Bucket secret key passed via HTTP Basic auth

Paths & Operations 5

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

Keys 5

Key-value operations within a bucket

GET
/{bucket_id}
List keys
listKeys 4 params → 200
GET
/{bucket_id}/{key}
Get key value
getKey 2 params → 200404
POST
/{bucket_id}/{key}
Set key value
setKey 2 params body → 200
PATCH
/{bucket_id}/{key}
Increment or decrement numeric value
patchKey 2 params body → 200
DELETE
/{bucket_id}/{key}
Delete key
deleteKey 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kvdb-keys-api-openapi.yml Raw ↑

Other APIs KVdb publishes across the network.

KVdb Buckets API
KVdb Scripts API