Query parameters

• q string

  An optional query to filter runners by. Maps to an Elasticsearch query_string query.

Responses

• 200 application/json

  An overview of all runners.

  Hide response attribute Show response attribute object

  • runners array[object] Required

    List of runners

    Information about a specified runner.

    Hide runners attributes Show runners attributes object

    • runner_id string Required

      The runner identifier

    • runner_name string

      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 object

      Build Info of the container artifact

      Hide build_info attributes Show build_info attributes object

      • commit_hash string

        Git commit hash

      • version string

        Version of the runner artifact

    • 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

      Information about a container within a runner.

      Hide containers attributes Show containers attributes object

      • container_name string Required

        Name of this container

      • container_set_name string Required

        Name of the container set for the container

    • roles array[object] Required

      Roles for the runner

      Information about a runner role.

      Hide roles attribute Show roles attribute object

      • role_name string Required

        Name of the role

    • connected boolean Required

      Specifies if the runner is connected

    • healthy boolean Required

      Specifies if the runner is healthy

    • health_checks object

      Checks used to determine if a runner is healthy or not

      Hide health_checks attributes Show health_checks attributes object

      • is_docker_healthy boolean Required

        Check performed by the runner to figure out if docker is healthy

      • is_connected_to_zk boolean Required

        Whether the runner is connected to zk or not

      • has_containers boolean Required

        Whether the runner has containers that it manages

    • region string

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