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

Etcd KV API

Key-value store operations including put, get, delete, and range queries

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

Tagged areas include KV. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 3.5.

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

5 operations 5 paths 15 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.5
Server
http://{host}:{port}/v3
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Etcd KV API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token obtained from the /auth/authenticate endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 5

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

KV 5

Key-value store operations including put, get, delete, and range queries

POST
/kv/put
Etcd Put a key-value pair
kvPut body → 200400401
POST
/kv/range
Etcd Get a range of key-value pairs
kvRange body → 200400401
POST
/kv/deleterange
Etcd Delete a range of key-value pairs
kvDeleteRange body → 200400401
POST
/kv/txn
Etcd Execute a transaction
kvTxn body → 200400401
POST
/kv/compaction
Etcd Compact the event history
kvCompact body → 200400

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RangeRequest (13 properties), Compare (9 properties), KeyValue (6 properties), PutRequest (6 properties). Each schema is shown below with its type and property counts.

TxnResponse
object
Response from a transaction execution
3 properties
DeleteRangeResponse
object
Response from a delete range operation
3 properties
PutResponse
object
Response from a put operation
2 properties
Compare
object
A condition in a transaction that compares a key's attribute to a target value
9 properties
CompactionRequest
object
Request to compact the etcd event history
2 properties 1 required
CompactionResponse
object
Response from a compaction operation
1 property
RangeRequest
object
Request to retrieve a range of key-value pairs from the etcd cluster
13 properties 1 required
ResponseHeader
object
Header included in every etcd response containing cluster metadata and the revision at which the response was generated.
4 properties
Error
object
Error response from the etcd API
3 properties
RangeResponse
object
Response from a range query
4 properties
RequestOp
object
An operation within a transaction's success or failure branch
4 properties
DeleteRangeRequest
object
Request to delete a range of key-value pairs from the etcd cluster
3 properties 1 required
PutRequest
object
Request to store a key-value pair in the etcd cluster
6 properties 2 required
KeyValue
object
A key-value pair stored in the etcd cluster. Keys and values are base64-encoded byte strings. The version field is the version of the key, the createrevision i…
6 properties
TxnRequest
object
An atomic compare-and-swap transaction consisting of conditions, success operations, and failure operations
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etcd-kv-api-openapi.yml Raw ↑

Other APIs Etcd publishes across the network.

etcd gRPC API
etcd Concurrency API
etcd Metrics API
etcd v2 HTTP API
Etcd Auth API
Etcd Cluster API
Etcd Lease API
Etcd Maintenance API
Etcd Watch API