Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Release control on a lease

Releases control held under `epoch`; its controller tokens stop working.

Releases control held under epoch; its controller tokens stop working.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:releaseControl
  • Scope sandboxes:exec
  • Effect write — a successful call changes state.
  • Collection leases

#Request

FieldTypeWhat it is
namestringThe name of the lease. Required.
epochint64The epoch AcquireLeaseControl returned. Required.

#Response

FieldTypeWhat it is
holderControlHolderWho holds control; UNSPECIFIED when nobody does (agent actions allowed). Output only. One of agent, human.
epochint64Increases on every acquire; release names it. Output only.
principalstringThe Access principal that acquired control. Output only.
holder_labelstringThe caller's label for the person or agent, for example a user id. Output only.
acquire_timetimestampWhen control was acquired. Output only.
expire_timetimestampWhen control lapses unless re-acquired. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:releaseControl" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"epoch":1}'