Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Lease events
A LeaseEvent is one immutable fact in a lease's life: grant, ready, end, control changes, network changes.
A LeaseEvent is one immutable fact in a lease's life: grant, ready, end, control changes, network changes. Events are listed in order and long-polled with wait.
Service Sylphx Sandboxes · Resource type sandboxes.sylphx.com/LeaseEvent · Name pattern orgs/{org}/projects/{project}/envs/{env}/leases/{lease}/lease_events/{lease_event} · Shape record
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/leases/{lease}/lease_events/{lease_event}. |
uid | string | lev_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
kind | LeaseEventKind | What happened. Output only. One of granted, ready, refused, ended, renewed, network_changed, control_acquired, control_released, control_expired, budget_warning, paused, resumed. |
sequence | int64 | The position in the lease's event sequence, from 1. Output only. |
occur_time | timestamp | When it happened. Output only. |
lease_generation | int64 | The lease generation after the event. Output only. |
state | LeaseState | The lease state after the event. Output only. One of requested, granted, ready, paused, ending, ended, refused. |
end_reason | EndReason | For LEASE_ENDED. Output only. One of released, expired, idle, cpu_budget, cost_budget, abuse, quota, org_deleted, machine_lost, boot_failed. |
usage | LeaseUsage | For LEASE_ENDED: final usage. Output only. |
control | ControlState | For CONTROL_* events: the control after the event. Output only. |
control_duration | duration | For CONTROL_RELEASED and CONTROL_EXPIRED: how long control was held. Output only. |
principal | string | The principal that caused it, when a caller did. Output only. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets one lease event. |
GET | list | Lists a lease's events in order. With wait, blocks up to that long for an event after page_token (long poll). |
#get
Gets one lease event.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease/lease_events/lease-event · scope sandboxes:read · effect read · Request, response and examples
#list
Lists a lease's events in order. With wait, blocks up to that long for an event after page_token (long poll).
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease/lease_events · scope sandboxes:read · effect read · paginated · Request, response and examples