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

id
string<uuid>
required

Runner id (UUIDv7).

Query Parameters

starting_after
string<uuid>

A lease id this runner holds; the page starts strictly after it. A lease id the runner does not hold is refused.

limit
integer
default:50

Rows per page (1-100).

Required range: 1 <= x <= 100

Response

A page of leases.

items
object[]
required
total
integer<int64> | null
required

The runner's full lease count; stable across pages.

next_cursor
string | null
required

The last lease id of a full page; null on the final page.