Get Nodes

Description: Gets a list of nodes.

Security: Requires a valid user

Usage: GET api/v1/nodes

Produces: application/json

Query Parameters:

Parameter	Data Type	Description	Required/Optional
`limit`	Integer	A limit on the number of nodes returned.	Optional
`skip`	Integer	A cursor for use in pagination. `skip` defines the number of nodes skipped.	Optional
`isOnDemand`	Boolean	Set to `true` for dynamic node pool. Set to `false` for static node pool.	Optional
`provisionedAt`	String	A filter on the list based on the `provisionedAt` property of the node.	Optional
`statusLastUpdatedAt`	String	A filter on the list based on the `statusLastUpdatedAt` property of the node.	Optional
`isAutoInitialized`	Boolean	A filter on the list based on the `isAutoInitialized` property of the node.	Optional
`lastInitializedAt`	Boolean	A filter on the list based on the `lastInitializedAt` property of the node. Exact matches only.	Optional
`nodeIds`	String	A filter on the list based on the `id` property of the node. Expects a comma separated string of nodeIds.	Optional
`nodePoolIds`	String	A filter on the list based on the `nodePoolId` property of the node. Expects a comma separated string of nodePoolIds.	Optional
`projectIds`	String	A filter on the list based on the `projectId` property of the node. Expects a comma separated string of projectIds.	Optional
`statusCodes`	String	A filter on the list based on the `statusCode` property of the node. Expects a comma separated string of statusCodes.	Optional
`status`	String	A filter on the list based on the 'status' of the node. Expects a comma separated value of statuses, which have corresponding systemCodes.	Optional
`sortBy`	String	The node properties to sort the results by. Expects a comma separated list of sorters.	Optional
`sortOrder`	Integer	A sort order based on the `sortBy` defined. If `1`, sorts the list in ascending order. If `-1`, sorts the list in descending order.	Optional

Sample Response:

GET /pipelines/api/v1/nodes

[
    {
        "instanceInfo": null,
        "providerMetadataPropertyBag": null,
        "initPropertyBag": {
            "insecureDockerRegistries": [
                "146.148.104.158:8082"
            ]
        },
        "systemPropertyBag": {
            "token": "e772f6f5-54ff-44e6-adfc-76b2b4a65610"
        },
        "id": 2,
        "projectId": 1,
        "statusCode": 4002,
        "friendlyName": "test",
        "currentBuildPlaneVersion": "1.7.9",
        "intendedBuildPlaneVersion": "1.7.9",
        "isOnDemand": false,
        "isAutoInitialized": true,
        "isDebug": null,
        "isSwapEnabled": false,
        "IPAddress": "34.122.216.34",
        "sshPort": 22,
        "sshUser": "root",
        "instanceId": null,
        "stepId": null,
        "statusLastUpdatedAt": "2021-03-31T20:02:06.112Z",
        "lastInitializedAt": "2021-02-10T07:12:03.000Z",
        "provisionedAt": null,
        "projectIntegrationId": null,
        "nodePoolId": 1,
        "stopRequested": false,
        "createdBy": "3",
        "updatedBy": "5",
        "createdAt": "2021-02-10T07:11:56.557Z",
        "updatedAt": "2021-03-31T20:02:06.112Z"
    }
]

Response Codes:

200: Success