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

Lease management for TTL-based key expiration

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

Tagged areas include Lease. 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 11 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 11 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 Lease 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.

Lease 5

Lease management for TTL-based key expiration

POST
/lease/grant
Etcd Grant a lease
leaseGrant body → 200400
POST
/lease/revoke
Etcd Revoke a lease
leaseRevoke body → 200400
POST
/lease/keepalive
Etcd Renew a lease
leaseKeepAlive body → 200400
POST
/lease/timetolive
Etcd Get lease time to live
leaseTimeToLive body → 200400
POST
/lease/leases
Etcd List all leases
leaseLeases → 200400

Schemas 11

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

LeaseRevokeRequest
object
Request to revoke an existing lease
1 property 1 required
LeaseGrantRequest
object
Request to create a new lease
2 properties 1 required
LeaseGrantResponse
object
Response from a lease grant operation
4 properties
LeaseTimeToLiveRequest
object
Request to get the TTL of a lease
2 properties 1 required
LeaseTimeToLiveResponse
object
Response from a lease TTL query
5 properties
LeaseRevokeResponse
object
Response from a lease revoke operation
1 property
Error
object
Error response from the etcd API
3 properties
LeaseKeepAliveResponse
object
Response from a lease keepalive operation
3 properties
LeaseLeasesResponse
object
Response from a list leases operation
2 properties
ResponseHeader
object
Header included in every etcd response containing cluster metadata and the revision at which the response was generated.
4 properties
LeaseKeepAliveRequest
object
Request to renew a lease
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etcd-lease-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 Maintenance API
Etcd Watch API