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
- 200
- 400
- 401
- 404
- 409
- 413
- 429
The endpoint with its new setting.
invalid_argument: an absent key, a value out of range or not a whole number, an unknown key, or a body that does not decode.
Missing, expired, revoked, or non-operator bearer.
not_found: no endpoint by that slug or id belongs to the caller (unknown and another human's are the same answer).
conflict: the endpoint is revoked; state says so.
The body is over 64 KiB.
rate_limited: the per-human write bucket is spent.