Lease

LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.

post/v3/lease/grant

Request

Base URL
https://etcd.io (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/etcd/apis/api-etcdserverpb-rpc-proto/docs/v3/lease/grant/post.ts
A function with typed inputs. Its response is checked against the schema.

IDstring int64

ID is the requested ID for the lease. If ID is set to 0, the lessor chooses an ID.

TTLstring int64

TTL is the advisory time-to-live in seconds. Expired lease will return -1.

A successful response.

IDstring int64

ID is the lease ID for the granted lease.

TTLstring int64

TTL is the server chosen lease time-to-live in seconds.

errorstring

No recorded changes to this operation across all 1 revision of this API.