Skip to main content
GET
List a runner's leases

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

runner_id
string
required

UUIDv7 of the runner.

Query Parameters

starting_after
string

A lease id this runner holds; the page starts strictly after it. A lease id the runner does not hold is refused. So is one outside the workspace_id or fleet filters when those filters are set. The cursor names a position in the filtered stream, so it must belong to it. A cursor whose lease the retention sweep has since deleted is refused for the same reason — start again from the first page.

workspace_id
string

Narrow the page and total to leases owned by one workspace. A malformed id is refused; an unknown one matches nothing.

fleet
string

Narrow the page and total to leases run for one fleet, named by its id or its exact name (case-insensitive). Combines with workspace_id; the two filters intersect. An empty or over-long value is refused; a value no fleet matches returns nothing.

limit
string

Rows per page (1-100).

Response

One page of the runner's leases, newest first

A keyset page of one runner's lease history.

items
object[]
required

Rows in newest-first order.

total
integer<int64>
required

Filtered total independent of the page boundary.

next_cursor
string | null

Last lease identifier when another page may exist.