Get runner

GET /platform/infrastructure/runners/{runner_id}

Retrieves a runner by id.

Path parameters

  • runner_id string Required

    The identifier for the runner

Responses

  • The information for the runner specified by {runner_id}.

    Hide response attributes Show response attributes object
    • runner_id string Required

      The runner identifier

    • The runner name

    • zone string

      Identifier of the zone

    • tags object

      Meta data of the runner, like image ID or processor architecture

      Hide tags attribute Show tags attribute object
      • * string Additional properties
    • features object

      State of features of the runner

      Hide features attribute Show features attribute object
      • * boolean Additional properties
    • Build Info of the container artifact

      Additional properties are allowed.

      Hide build_info attributes Show build_info attributes object
    • host_ip string Required

      Host IP for the runner

    • public_hostname string Required

      Public hostname for the runner

    • containers array[object] Required

      Containers for the runner

      Hide containers attributes Show containers attributes object
    • roles array[object] Required

      Roles for the runner

      Hide roles attribute Show roles attribute object
    • connected boolean Required

      Specifies if the runner is connected

    • healthy boolean Required

      Specifies if the runner is healthy

    • Checks used to determine if a runner is healthy or not

      Additional properties are allowed.

      Hide health_checks attributes Show health_checks attributes object
    • region string

      The region that this runner belongs to. Only populated in SaaS or federated ECE.

  • Unable to find the {runner_id} specified runner. Edit your request, then try again. (code: runners.runner_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is runners.runner_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/infrastructure/runners/{runner_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id}
Response examples (200)
{
  "runner_id": "string",
  "runner_name": "string",
  "zone": "string",
  "tags": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "features": {
    "additionalProperty1": true,
    "additionalProperty2": true
  },
  "build_info": {
    "commit_hash": "string",
    "version": "string"
  },
  "host_ip": "string",
  "public_hostname": "string",
  "containers": [
    {
      "container_name": "string",
      "container_set_name": "string"
    }
  ],
  "roles": [
    {
      "role_name": "string"
    }
  ],
  "connected": true,
  "healthy": true,
  "health_checks": {
    "is_docker_healthy": true,
    "is_connected_to_zk": true,
    "has_containers": true
  },
  "region": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: runners.runner_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}