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

Maintenance operations including snapshots, defragmentation, and status

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

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

This API exposes 6 operations across 6 paths, and defines 10 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.

6 operations 6 paths 10 schemas 6 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 Maintenance 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 6

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

Maintenance 6

Maintenance operations including snapshots, defragmentation, and status

POST
/maintenance/snapshot
Etcd Stream a database snapshot
maintenanceSnapshot → 200401
POST
/maintenance/defragment
Etcd Defragment a member's backend
maintenanceDefragment → 200401
POST
/maintenance/status
Etcd Get member status
maintenanceStatus → 200401
POST
/maintenance/alarm
Etcd Manage cluster alarms
maintenanceAlarm body → 200401
POST
/maintenance/hash
Etcd Get member backend hash
maintenanceHash → 200
POST
/maintenance/transfer-leadership
Etcd Transfer cluster leadership
maintenanceTransferLeadership body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are StatusResponse (10 properties), ResponseHeader (4 properties), AlarmRequest (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

DefragmentResponse
object
Response from a defragmentation operation
1 property
MoveLeaderRequest
object
Request to transfer cluster leadership
1 property 1 required
AlarmMember
object
An alarm associated with a cluster member
2 properties
AlarmRequest
object
Request to manage cluster alarms
3 properties
AlarmResponse
object
Response from an alarm operation
2 properties
Error
object
Error response from the etcd API
3 properties
HashResponse
object
Response from a backend hash query
2 properties
MoveLeaderResponse
object
Response from a leadership transfer operation
1 property
ResponseHeader
object
Header included in every etcd response containing cluster metadata and the revision at which the response was generated.
4 properties
StatusResponse
object
Response from a member status query
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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