runner_instances

Update Runner Instance Admin

patch/runner_instances/admin/{public_id}

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/runner_instances/admin/{public_id}
  • Auth: HTTP bearer

Path parameters

public_idstring uuid required

Headers

x-public-tenant-idstring uuid nullable
x-public-user-idstring uuid nullable

Request body

status'starting' | 'in_progress' | 'capacity_waiting' | 'completed' | 'failed' | 'cancelled' | 'replaced' | 'lost' | 'force_failed'
instance_idstring nullable
provider'namespace' | 'bear_agent'
namespace_statusstring nullable
errorstring nullable
started_atstring date-time nullable
completed_atstring date-time nullable
last_notified_atstring date-time nullable
replaced_by_idstring uuid nullable
recreate_attemptsinteger nullable
jit_runner_idinteger nullable
creation_paramsobject

Response

Successful Response

public_idstring uuid required
tenant_idstring uuid required
repostring required
github_job_idstring required
workflow_run_idstring required
run_attemptinteger required
cache_keystring required
status'starting' | 'in_progress' | 'capacity_waiting' | 'completed' | 'failed' | 'cancelled' | 'replaced' | 'lost' | 'force_failed' required
instance_idstring nullable required
provider'namespace' | 'bear_agent' required
namespace_statusstring nullable required
errorstring nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required
last_notified_atstring date-time nullable required
replaced_by_idstring uuid nullable required
recreate_attemptsinteger required
jit_runner_idinteger nullable required
creation_paramsobject required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.