Cook Runner Object

Health and status information for a single cook runner agent.

idstring<uuid>

Unique identifier of the cook runner.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

namestringnullable

Name of the cook runner.

Example: cook-runner-1

cloud_portal_identifierstring

Cloud portal identifier for the cook runner.

Example: azure-runner-001

versionstringnullable

Version of the cook runner agent.

Example: 1.0.0

virtual_machine_typestring

Name of the underlying virtual machine.

Example: Standard_D4ads_v5

created_atinteger<int64>

Unix timestamp of when the cook runner was created.

Example: 1718787600

statusstring

Health status of the cook runner.

Possible values: [Healthy, Degraded, Unhealthy, Draining]

Example: Healthy

descriptionstringnullable

Human-readable description of the current status.

Example: cook-runner-1 is currently running a job

jobs object[]

Array of jobs currently running on this cook runner. Empty when idle.

Array [

mod_idinteger<int64>nullable

ID of the mod being processed.

Example: 123

platformsstring[]

Target platforms for this job.

Example: ["Windows","Linux"]

job_stepstringnullable

Current step of the job.

Example: Cooking

job_idstring<uuid>

Unique identifier of the job.

]

Cook Runner Object

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "cook-runner-1",
  "cloud_portal_identifier": "azure-runner-001",
  "version": "1.0.0",
  "virtual_machine_type": "Standard_D4ads_v5",
  "created_at": 1718787600,
  "status": "Healthy",
  "description": "cook-runner-1 is currently running a job",
  "jobs": [
    {
      "mod_id": 123,
      "platforms": [
        "Windows",
        "Linux"
      ],
      "job_step": "Cooking",
      "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}