GET /platform/infrastructure/runners/{runner_id}
Basic auth Api key

Retrieves a runner by id.

Path parameters

  • runner_id string Required

    The identifier for the runner

Responses

  • 200 application/json

    The information for the runner specified by {runner_id}.

    Hide response attributes Show response 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
      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

      The checks performed to determine if an 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.
  • 404 application/json

    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
    • x-cloud-error-codes string

      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 \
 --request GET 'https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id}' \
 --user "username:password"