Skip to main content

Edit an endpoint's settings (its default claim lease)

PATCH 

/api/v1/endpoints/:ref

Edits the settings of an endpoint you own that are not scope (ADR-0043). Today that is default_lease_ttl_seconds: the lease a claim, claim_next or heartbeat on the endpoint gets when the call passes no lease_ttl_seconds. An integer from 60 to 86400 sets it; null resets it to the server default (300). Out of range is refused, never clamped. The key is required, and any other key is refused: scope is fixed at vend (SPEC-0007). The edit applies to claims and heartbeats made after it; leases already granted keep their expiry. Draws from the per-human write bucket (429 with Retry-After when spent).

Request​

Responses​

The endpoint with its new setting.