Get Node Pools

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Gets a collection of node pools entities.

Security: Requires a valid user

Usage: GET api/v1/nodePools

Produces: application/json

Parameters:

Parameter

Data Type

Description

nodePoolIds

Integer

Comma-separated list of numeric nodePool ids

projectIds

Integer

Comma-separated list of numeric project ids

projectIntegrationIds

Integer

Comma-separated list of numeric projectIntegration ids

names

String

Comma-separated list of the names of the node pools

Sample Response:

An array of node pools that satisfy all the supplied query parameters. Returns all node pools if no query parameters are supplied.

[
    {
        "providerMetadataPropertyBag": {
            "instanceSize": "n1-standard-1",
            "subnetName": "jfrog-usw1-dynamicnodes",
            "networkTags": [
                "behind-nat",
                "jenkins",
                "pipelines",
                "xray-app",
                "xray-apps"
            ],
            "zone": "us-west1-b"
        },
        "cacheSettingsPropertyBag": null,
        "initPropertyBag": {
            "insecureDockerRegistries": []
        },
        "permissions": {
            "allowAllPipelineSources": true
        },
        "id": 2,
        "projectId": 1,
        "environments": null,
        "name": "u18-vms",
        "queueName": null,
        "numberOfNodes": 3,
        "isOnDemand": true,
        "architecture": "x86_64",
        "operatingSystem": "Ubuntu_18.04",
        "maxDiskUsagePercentage": 90,
        "diskSizeinGB": null,
        "timeoutMS": null,
        "isNatEnabled": null,
        "isCacheEnabled": false,
        "projectIntegrationId": 11,
        "buildPlaneImageId": 17,
        "nodeIdleIntervalInMins": 20,
        "createdAt": "2021-01-25T02:38:56.322Z",
        "updatedAt": "2021-01-25T02:38:56.322Z"
    },
    {
        "providerMetadataPropertyBag": null,
        "cacheSettingsPropertyBag": null,
        "initPropertyBag": {
            "insecureDockerRegistries": []
        },
        "permissions": {
            "allowAllPipelineSources": true
        },
        "id": 1,
        "projectId": 1,
        "environments": null,
        "name": "win_2019",
        "queueName": null,
        "numberOfNodes": null,
        "isOnDemand": false,
        "architecture": "x86_64",
        "operatingSystem": "WindowsServer_2019",
        "maxDiskUsagePercentage": 90,
        "diskSizeinGB": null,
        "timeoutMS": null,
        "isNatEnabled": null,
        "isCacheEnabled": null,
        "projectIntegrationId": null,
        "buildPlaneImageId": null,
        "nodeIdleIntervalInMins": null,
        "createdAt": "2021-01-17T14:05:46.289Z",
        "updatedAt": "2021-02-03T18:13:05.672Z"
    },
    {
        "providerMetadataPropertyBag": {
            "keyPairName": "pipelines_testing",
            "securityGroupId": "sg-0a21d376a34db8ae5",
            "subnetId": "subnet-0e4461a8e780478a6",
            "instanceSize": "c4.large"
        },
        "cacheSettingsPropertyBag": null,
        "initPropertyBag": {
            "insecureDockerRegistries": []
        },
        "permissions": {
            "allowAllPipelineSources": true
        },
        "id": 5,
        "projectId": 1,
        "environments": null,
        "name": "awswin_2019",
        "queueName": null,
        "numberOfNodes": 3,
        "isOnDemand": true,
        "architecture": "x86_64",
        "operatingSystem": "WindowsServer_2019",
        "maxDiskUsagePercentage": 90,
        "diskSizeinGB": null,
        "timeoutMS": null,
        "isNatEnabled": null,
        "isCacheEnabled": false,
        "projectIntegrationId": 29,
        "buildPlaneImageId": 7,
        "nodeIdleIntervalInMins": 20,
        "createdAt": "2021-03-19T18:46:42.051Z",
        "updatedAt": "2021-03-19T19:12:34.449Z"
    }
]

Response Codes:

200: Success