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

Watch operations for streaming key change notifications

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

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

This API exposes 1 operation across 1 path, and defines 7 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.

1 operations 1 paths 7 schemas 1 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 Watch 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 1

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

Watch 1

Watch operations for streaming key change notifications

POST
/watch
Etcd Watch for key change events
watchEvents body → 200400401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are WatchCreateRequest (8 properties), WatchResponse (8 properties), KeyValue (6 properties), ResponseHeader (4 properties). Each schema is shown below with its type and property counts.

WatchResponse
object
A streaming response from the watch endpoint
8 properties
WatchRequest
object
A watch stream request that can create or cancel watches
2 properties
WatchCreateRequest
object
Request to create a new watch on a key range
8 properties
WatchEvent
object
An event describing a change to a key in the etcd cluster
3 properties
Error
object
Error response from the etcd API
3 properties
ResponseHeader
object
Header included in every etcd response containing cluster metadata and the revision at which the response was generated.
4 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etcd-watch-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 KV API
Etcd Lease API
Etcd Maintenance API