Runners¶
Choose an API for the resource you need to operate on, then prepare the identity, IDs, and parameters listed on its action page.
Choose a task¶
Task |
Page |
Description |
|---|---|---|
Get compute instance Python dependency observations |
Return saved observations for the current desired SHA, cloud provider, and instance states STARTING/READY/STOPPING. This is not a list of all Workers or live Pods. |
|
Register a custom Runner |
HTTP 200 means record and ownership creation completed. phase=pending does not mean Edge is connected. |
|
Unregister a Runner |
Deregistration involves blocking new invocations, cleaning associated native sessions, revoking tokens, and deleting ownership and records. |
|
Get visible executor connection states |
Return connection projections for currently visible Runners and enabled Sandboxes. |
|
Get Runner details |
Read records and token expiration without issuing new credentials or retrieving historical connect_cmd. |
|
Runner connectivity and observation lifecycle |
Successful registration, Edge connection, execution admission, and compute dependency installation each have independent states. Each step needs its own decision criteria. |
|
List Runners |
Return Runners readable in the current workspace with internal lifecycle active, sorted by creation time descending, without filtering by registering user. |
|
Runner and compute observation objects |
These APIs distinguish product-identity management, connectivity, Edge-holder renewal, and compute dependency observations. |
|
Get Python dependency configuration limits |
Read dynamic deployment configuration for enabled status, size/line limits, index domains, and installation timeout. This is not specific to a compute instance and does not modify global configuration. |
|
Refresh Runner connection credentials |
Use agent_runner.manage to revoke the old JTI, update the current binding, and return a new connect_cmd while retaining Runner and Edge IDs. |
|
Renew an Edge registration token |
Holder protocol, without product identity wrapping. |