WarpBuild LogoWarpBuild Docs
Runner images

GET /runner-images

GET
/runner-images

Authorization

JWTKeyAuth
Authorization<token>

In: header

Query Parameters

alias?string

Alias

runner_image_pull_secret_id?string

Runner Image Pull Secret ID

stack_kind?string

Stack Kind

region?string

Region

arch?array<string>

Arch

os?array<string>

OS

type?array<string>

Type

warpbuild_snapshot_image.vcs_repository_names?array<string>

Snapshot VCS Repositories Names. These will be an and operation so other image types if passed will be ignored except the warpbuild_managed images

warpbuild_snapshot_image.vcs_ref_names?array<string>

Snapshot VCS Branches Names. These will be an and operation so other image types if passed will be ignored except the warpbuild_managed images

warpbuild_snapshot_image.vcs_organization_names?array<string>

Snapshot VCS organization (GitHub org) names to filter snapshot images by

page?integer

Page. Only supported when type doesn't include warpbuild_managed

per_page?integer

Per Page. Only supported when type doesn't include warpbuild_managed

Response Body

application/json

application/json

application/json

curl -X GET "https://api.warpbuild.com/api/v1/runner-images"
{
  "next_page": 0,
  "page": 0,
  "per_page": 0,
  "runner_images": [
    {
      "alias": "string",
      "arch": "string",
      "byoc_ami": {
        "ami_id": "string",
        "root_device_name": "string"
      },
      "container_runner_image": {
        "args": [
          "string"
        ],
        "command": "string",
        "entrypoint": "string",
        "environment_variables": {
          "property1": "string",
          "property2": "string"
        },
        "image_repository": "string",
        "image_tag": "string"
      },
      "created_at": "string",
      "deprecated": true,
      "hooks": [
        {
          "file": "string",
          "type": "github_prehook"
        }
      ],
      "id": "string",
      "organization_id": "string",
      "os": "string",
      "parent_image_id": "string",
      "root_parent_image_id": "string",
      "runner_image_pull_secret_id": "string",
      "settings": {
        "purge_image_versions_offset": 0
      },
      "stack_id": "string",
      "status": "creating",
      "type": "container",
      "updated_at": "string",
      "version": {
        "arch": "string",
        "byoc_ami": {
          "ami_id": "string",
          "root_device_name": "string"
        },
        "container_runner_image": {
          "data_dir_size": "string",
          "image_digest": "string",
          "image_repository": "string",
          "image_size": "string",
          "image_tag": "string",
          "image_uri": "string",
          "snapshot_id": "string",
          "snapshot_size": "string",
          "volume_id": "string",
          "volume_size_gb": 0
        },
        "created_at": "string",
        "expires_at": "string",
        "external_id": "string",
        "id": "string",
        "meta": {
          "event": null,
          "parsed_event": null
        },
        "organization_id": "string",
        "os": "string",
        "parent_image_id": "string",
        "root_parent_image_id": "string",
        "runner_image_id": "string",
        "runner_image_pull_secret_id": "string",
        "stack_id": "string",
        "status": "string",
        "type": "string",
        "updated_at": "string",
        "version_time_id": 0,
        "warpbuild_snapshot_image": {
          "ami_id": "string",
          "creator_runner_instance_id": "string",
          "provider": "string",
          "snapshot_id": "string",
          "vcs_organization_name": "string",
          "vcs_ref_name": "string",
          "vcs_repository_name": "string",
          "version_id": 0
        }
      },
      "warpbuild_image": {
        "cloud_init_template": "string",
        "image_uri": "string"
      },
      "warpbuild_snapshot_image": {
        "ami_id": "string",
        "creator_runner_instance_id": "string",
        "provider": "string",
        "snapshot_id": "string",
        "vcs_organization_name": "string",
        "vcs_ref_name": "string",
        "vcs_repository_name": "string",
        "version_id": 0
      },
      "work_dir": "string"
    }
  ],
  "total_items": 0,
  "total_pages": 0
}
{
  "code": "string",
  "description": "string",
  "message": "string",
  "sub_code": "string",
  "sub_message": "string"
}
{
  "code": "string",
  "description": "string",
  "message": "string",
  "sub_code": "string",
  "sub_message": "string"
}