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

Cluster membership management including member add, remove, and list

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

Tagged areas include Cluster. 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 12 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 12 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 Cluster 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.

Cluster 5

Cluster membership management including member add, remove, and list

POST
/cluster/member/add
Etcd Add a member to the cluster
clusterMemberAdd body → 200400
POST
/cluster/member/remove
Etcd Remove a member from the cluster
clusterMemberRemove body → 200400
POST
/cluster/member/update
Etcd Update a cluster member
clusterMemberUpdate body → 200400
POST
/cluster/member/list
Etcd List cluster members
clusterMemberList → 200400
POST
/cluster/member/promote
Etcd Promote a learner member
clusterMemberPromote body → 200400

Schemas 12

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

MemberPromoteRequest
object
Request to promote a learner member to a voting member
1 property 1 required
MemberPromoteResponse
object
Response from a member promote operation
2 properties
MemberAddResponse
object
Response from a member add operation
3 properties
MemberAddRequest
object
Request to add a new member to the cluster
2 properties 1 required
MemberListResponse
object
Response from a member list operation
2 properties
MemberUpdateRequest
object
Request to update a cluster member's peer URLs
2 properties 2 required
Member
object
A member of the etcd cluster
5 properties
MemberRemoveRequest
object
Request to remove a member from the cluster
1 property 1 required
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
MemberRemoveResponse
object
Response from a member remove operation
2 properties
MemberUpdateResponse
object
Response from a member update operation
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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