Get Build Plane Image Ids

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Gets a list of machine Image Ids used to bring up dynamic nodes.

Security: Requires admin credentials

Usage: GET api/v1/buildPlaneImages

Produces: application/json

Query Parameters:

Parameter

Data Type

Description

Required/Optional

buildPlaneImageIds

String

A filter on the list based on the id property of the buildPlaneImage. Expects a comma separated string of buildPlaneImageIds.

Required

masterIntegrationIds

String

A filter on the list based on the masterIntegrationId that the buildPlaneImage belongs to. Expects a comma separated list of masterIntegrationIds. For more information, see Get MasterIntegrations.

Required

isAvailable

Boolean

A filter on the list based on the isAvailable property of buildPlaneImage.

Required

Sample Response:

Response - Shortened for brevity

[
    {
        "metadataPropertyBag": {
            "projectName": "pipelines-cloud-stg",
            "imageName": "us-west1-image-for-x86-64-ubuntu20-1620598096542"
        },
        "id": 8,
        "name": "us-west1 image for x86_64 Ubuntu_20.04",
        "masterIntegrationId": 76,
        "imageId": "9171597764075670053",
        "region": "us1",
        "isAvailable": true,
        "architecture": "x86_64",
        "operatingSystem": "Ubuntu_20.04",
        "createdAt": "2021-01-06T00:00:00.000Z",
        "updatedAt": "2021-01-06T00:00:00.000Z"
    },
    {
        "metadataPropertyBag": {
            "type": "published",
            "plan": {
                "name": "x86_64-ubuntu_20_04",
                "product": "pipelines-buildplane",
                "publisher": "jfrog"
            }
        },
        "id": 95,
        "name": "westeurope image for x86_64 Ubuntu_20.04",
        "masterIntegrationId": 87,
        "imageId": "jg:pipelines-buildplane:x86_64-ubuntu_20_04:1.10.1:pe",
        "region": "westeurope",
        "isAvailable": true,
        "architecture": "x86_64",
        "operatingSystem": "Ubuntu_20.04",
        "createdAt": "2021-03-16T00:00:00.000Z",
        "updatedAt": "2021-03-16T00:00:00.000Z"
    },
    {
        "metadataPropertyBag": {
            "type": "published",
            "plan": {
                "name": "x86_64-ubuntu_20_04",
                "product": "pipelines-buildplane",
                "publisher": "jfrog"
            }
        },
        "id": 96,
        "name": "eastus image for x86_64 Ubuntu_20.04",
        "masterIntegrationId": 87,
        "imageId": "jg:pipelines-buildplane:x86_64-ubuntu_20_04:1.10.1:tus",
        "region": "eastus",
        "isAvailable": true,
        "architecture": "x86_64",
        "operatingSystem": "Ubuntu_20.04",
        "createdAt": "2021-03-16T00:00:00.000Z",
        "updatedAt": "2021-03-16T00:00:00.000Z"
    }
]