NodePools

Node pools assist in managing heterogeneous resources effectively. A node pool is a set of nodes grouped into a bucket of resources using a predefined (for example, GPU-Type) or administrator-defined label (for example, key & value). For more information, see Node Pools.

Get the node pool metrics data.

get

Retrieve the node pool metrics data by Universally Unique Identifier (UUID).

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterUuidstring · uuid · min: 1Required

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

nodepoolNamestringRequired

The unique nodepool name.

Example: default

Query parameters

startstring · date-timeRequired

Start date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-06T12:09:18.211Z

endstring · date-timeRequired

End date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-07T12:09:18.211Z

numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20

Responses

200

Executed successfully.

207

Partial success.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/clusters/{clusterUuid}/nodepools/{nodepoolName}/metrics

GET /api/v1/clusters/{clusterUuid}/nodepools/{nodepoolName}/metrics?start=2023-06-06T12%3A09%3A18.211Z&end=2023-06-07T12%3A09%3A18.211Z&metricType=TOTAL_GPU_NODES HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "measurements": [
    {
      "type": "ALLOCATED_GPU",
      "labels": "{'gpu': '3'}",
      "values": [
        {
          "value": "85",
          "timestamp": "2023-06-06 12:09:18.211"
        }
      ]
    }
  ]
}

Get nodepools

get

Get nodepools

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["name!=some-name"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

Responses

200

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/node-pools

GET /api/v1/node-pools HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nodepools": [
    {
      "name": "v100",
      "labelKey": "node-type",
      "labelValue": "type-x",
      "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
      "gpuNetworkAccelerationLabelKey": "text",
      "gpuNetworkAccelerationDetection": "Auto",
      "networkTopologyName": "default-topology",
      "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
      "gpuResourceOptimization": {
        "swapEnabled": true,
        "cpuSwapMemorySize": "10000M",
        "reservedGpuMemoryForSwapOperations": "10G",
        "nodeLevelSchedulerEnabled": true
      },
      "schedulingConfiguration": {
        "placementStrategy": {
          "cpu": "spread",
          "gpu": "spread"
        },
        "minGuaranteedRuntime": "5d8h40m"
      },
      "phase": "Creating",
      "phaseMessage": "all nodes are down",
      "status": {
        "labelKey": "node-type",
        "labelValue": "type-x",
        "gpuNetworkAccelerationLabelKey": "text",
        "gpuNetworkAccelerationDetection": "Auto",
        "gpuResourceOptimization": {
          "swapEnabled": true,
          "cpuSwapMemorySize": "10000M",
          "reservedGpuMemoryForSwapOperations": "10G",
          "nodeLevelSchedulerEnabled": true
        },
        "schedulingConfiguration": {
          "placementStrategy": {
            "cpu": "spread",
            "gpu": "spread"
          },
          "minGuaranteedRuntime": "5d8h40m"
        },
        "conditions": [
          {
            "type": "text",
            "reason": "TopologyMismatch",
            "message": "Network Topology labels mismatch",
            "status": "True",
            "nodes": [
              "node1",
              "node2"
            ]
          }
        ],
        "gpuNetworkAccelerationDetected": true,
        "nodes": [
          "node1"
        ]
      },
      "id": 5,
      "tenantId": 1,
      "clusterName": "prod-cluster",
      "createdBy": "[email protected]",
      "createdAt": "2026-05-19T17:00:11.478Z",
      "updatedBy": "[email protected]",
      "updatedAt": "2026-05-19T17:00:11.478Z",
      "deletedBy": "[email protected]",
      "deletedAt": "2026-05-19T17:00:11.478Z",
      "isDefault": false
    }
  ]
}

Create nodepool

post

Create nodepool

Authorizations

AuthorizationstringRequired

Bearer authentication

Body

namestring · min: 1RequiredExample: v100

labelKeystring · min: 1Required

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1Required

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

clusterIdstring · uuidRequiredExample: d73a738f-fab3-430a-8fa3-5241493d7128

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

201

Created

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

post

/api/v1/node-pools

POST /api/v1/node-pools HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "networkTopologyName": "default-topology",
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "phase": "Creating",
  "phaseMessage": "all nodes are down",
  "status": {
    "labelKey": "node-type",
    "labelValue": "type-x",
    "gpuNetworkAccelerationLabelKey": "text",
    "gpuNetworkAccelerationDetection": "Auto",
    "gpuResourceOptimization": {
      "swapEnabled": true,
      "cpuSwapMemorySize": "10000M",
      "reservedGpuMemoryForSwapOperations": "10G",
      "nodeLevelSchedulerEnabled": true
    },
    "schedulingConfiguration": {
      "placementStrategy": {
        "cpu": "spread",
        "gpu": "spread"
      },
      "minGuaranteedRuntime": "5d8h40m"
    },
    "conditions": [
      {
        "type": "text",
        "reason": "TopologyMismatch",
        "message": "Network Topology labels mismatch",
        "status": "True",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "gpuNetworkAccelerationDetected": true,
    "nodes": [
      "node1"
    ]
  },
  "id": 5,
  "tenantId": 1,
  "clusterName": "prod-cluster",
  "createdBy": "[email protected]",
  "createdAt": "2026-05-19T17:00:11.478Z",
  "updatedBy": "[email protected]",
  "updatedAt": "2026-05-19T17:00:11.478Z",
  "deletedBy": "[email protected]",
  "deletedAt": "2026-05-19T17:00:11.478Z",
  "isDefault": false
}

Count nodepools

get

Count nodepools

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Example: ["name!=some-name"]

Responses

200

application/json

countinteger · int64Required

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/node-pools/count

GET /api/v1/node-pools/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get nodepool

get

Get nodepool

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17

Responses

200

Requested nodepool

application/json

namestringRequiredExample: v100

labelKeystring · min: 1Required

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1Required

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

clusterIdstring · uuidRequiredExample: d73a738f-fab3-430a-8fa3-5241493d7128

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystringOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyNamestring · min: 1 · max: 63 · nullableOptional

Name of the network topology

Example: default-topologyPattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

phasestring · enumOptional

Phase of Node Pool

Possible values:

phaseMessagestringOptional

Message for status of Node Pool

Example: all nodes are down

idstringRead-onlyRequired

The NodePool id

Example: 5

tenantIdinteger · int32Required

The id of the tenant.

Example: 1

clusterNamestringRequiredExample: prod-cluster

createdBystringRequiredExample: [email protected]

createdAtstring · date-timeRequired

updatedBystringRequiredExample: [email protected]

updatedAtstring · date-timeRequired

deletedBystringOptionalExample: [email protected]

deletedAtstring · date-time · nullableOptional

isDefaultbooleanRequired

Is the Node Pool is the cluster default

Example: false

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/node-pools/{nodepoolId}

GET /api/v1/node-pools/{nodepoolId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "networkTopologyName": "default-topology",
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "phase": "Creating",
  "phaseMessage": "all nodes are down",
  "status": {
    "labelKey": "node-type",
    "labelValue": "type-x",
    "gpuNetworkAccelerationLabelKey": "text",
    "gpuNetworkAccelerationDetection": "Auto",
    "gpuResourceOptimization": {
      "swapEnabled": true,
      "cpuSwapMemorySize": "10000M",
      "reservedGpuMemoryForSwapOperations": "10G",
      "nodeLevelSchedulerEnabled": true
    },
    "schedulingConfiguration": {
      "placementStrategy": {
        "cpu": "spread",
        "gpu": "spread"
      },
      "minGuaranteedRuntime": "5d8h40m"
    },
    "conditions": [
      {
        "type": "text",
        "reason": "TopologyMismatch",
        "message": "Network Topology labels mismatch",
        "status": "True",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "gpuNetworkAccelerationDetected": true,
    "nodes": [
      "node1"
    ]
  },
  "id": 5,
  "tenantId": 1,
  "clusterName": "prod-cluster",
  "createdBy": "[email protected]",
  "createdAt": "2026-05-19T17:00:11.478Z",
  "updatedBy": "[email protected]",
  "updatedAt": "2026-05-19T17:00:11.478Z",
  "deletedBy": "[email protected]",
  "deletedAt": "2026-05-19T17:00:11.478Z",
  "isDefault": false
}

Update nodepool

put

Update nodepool

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17

Body

labelKeystring · min: 1 · nullableOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1 · nullableOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Updated

application/json

namestringRequiredExample: v100

labelKeystring · min: 1Required

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1Required

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

clusterIdstring · uuidRequiredExample: d73a738f-fab3-430a-8fa3-5241493d7128

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystringOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyNamestring · min: 1 · max: 63 · nullableOptional

Name of the network topology

Example: default-topologyPattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

phasestring · enumOptional

Phase of Node Pool

Possible values:

phaseMessagestringOptional

Message for status of Node Pool

Example: all nodes are down

idstringRead-onlyRequired

The NodePool id

Example: 5

tenantIdinteger · int32Required

The id of the tenant.

Example: 1

clusterNamestringRequiredExample: prod-cluster

createdBystringRequiredExample: [email protected]

createdAtstring · date-timeRequired

updatedBystringRequiredExample: [email protected]

updatedAtstring · date-timeRequired

deletedBystringOptionalExample: [email protected]

deletedAtstring · date-time · nullableOptional

isDefaultbooleanRequired

Is the Node Pool is the cluster default

Example: false

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/api/v1/node-pools/{nodepoolId}

PUT /api/v1/node-pools/{nodepoolId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "labelKey": "node-type",
  "labelValue": "type-x",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "networkTopologyName": "default-topology",
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "phase": "Creating",
  "phaseMessage": "all nodes are down",
  "status": {
    "labelKey": "node-type",
    "labelValue": "type-x",
    "gpuNetworkAccelerationLabelKey": "text",
    "gpuNetworkAccelerationDetection": "Auto",
    "gpuResourceOptimization": {
      "swapEnabled": true,
      "cpuSwapMemorySize": "10000M",
      "reservedGpuMemoryForSwapOperations": "10G",
      "nodeLevelSchedulerEnabled": true
    },
    "schedulingConfiguration": {
      "placementStrategy": {
        "cpu": "spread",
        "gpu": "spread"
      },
      "minGuaranteedRuntime": "5d8h40m"
    },
    "conditions": [
      {
        "type": "text",
        "reason": "TopologyMismatch",
        "message": "Network Topology labels mismatch",
        "status": "True",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "gpuNetworkAccelerationDetected": true,
    "nodes": [
      "node1"
    ]
  },
  "id": 5,
  "tenantId": 1,
  "clusterName": "prod-cluster",
  "createdBy": "[email protected]",
  "createdAt": "2026-05-19T17:00:11.478Z",
  "updatedBy": "[email protected]",
  "updatedAt": "2026-05-19T17:00:11.478Z",
  "deletedBy": "[email protected]",
  "deletedAt": "2026-05-19T17:00:11.478Z",
  "isDefault": false
}

Delete nodepool

delete

Delete nodepool

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17

Responses

202

Accepted.

application/json

204

No Content.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/node-pools/{nodepoolId}

DELETE /api/v1/node-pools/{nodepoolId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}

Patch nodepool fields

patch

Update only specific fields of a nodepool

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17

Body

labelKeystring · min: 1 · nullableOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1 · nullableOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Updated

application/json

namestringRequiredExample: v100

labelKeystring · min: 1Required

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestring · min: 1Required

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

clusterIdstring · uuidRequiredExample: d73a738f-fab3-430a-8fa3-5241493d7128

overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1

gpuNetworkAccelerationLabelKeystringOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:

networkTopologyNamestring · min: 1 · max: 63 · nullableOptional

Name of the network topology

Example: default-topologyPattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000

phasestring · enumOptional

Phase of Node Pool

Possible values:

phaseMessagestringOptional

Message for status of Node Pool

Example: all nodes are down

idstringRead-onlyRequired

The NodePool id

Example: 5

tenantIdinteger · int32Required

The id of the tenant.

Example: 1

clusterNamestringRequiredExample: prod-cluster

createdBystringRequiredExample: [email protected]

createdAtstring · date-timeRequired

updatedBystringRequiredExample: [email protected]

updatedAtstring · date-timeRequired

deletedBystringOptionalExample: [email protected]

deletedAtstring · date-time · nullableOptional

isDefaultbooleanRequired

Is the Node Pool is the cluster default

Example: false

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/node-pools/{nodepoolId}

PATCH /api/v1/node-pools/{nodepoolId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "labelKey": "node-type",
  "labelValue": "type-x",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "gpuNetworkAccelerationLabelKey": "text",
  "gpuNetworkAccelerationDetection": "Auto",
  "networkTopologyName": "default-topology",
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
  "gpuResourceOptimization": {
    "swapEnabled": true,
    "cpuSwapMemorySize": "10000M",
    "reservedGpuMemoryForSwapOperations": "10G",
    "nodeLevelSchedulerEnabled": true
  },
  "schedulingConfiguration": {
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m"
  },
  "phase": "Creating",
  "phaseMessage": "all nodes are down",
  "status": {
    "labelKey": "node-type",
    "labelValue": "type-x",
    "gpuNetworkAccelerationLabelKey": "text",
    "gpuNetworkAccelerationDetection": "Auto",
    "gpuResourceOptimization": {
      "swapEnabled": true,
      "cpuSwapMemorySize": "10000M",
      "reservedGpuMemoryForSwapOperations": "10G",
      "nodeLevelSchedulerEnabled": true
    },
    "schedulingConfiguration": {
      "placementStrategy": {
        "cpu": "spread",
        "gpu": "spread"
      },
      "minGuaranteedRuntime": "5d8h40m"
    },
    "conditions": [
      {
        "type": "text",
        "reason": "TopologyMismatch",
        "message": "Network Topology labels mismatch",
        "status": "True",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "gpuNetworkAccelerationDetected": true,
    "nodes": [
      "node1"
    ]
  },
  "id": 5,
  "tenantId": 1,
  "clusterName": "prod-cluster",
  "createdBy": "[email protected]",
  "createdAt": "2026-05-19T17:00:11.478Z",
  "updatedBy": "[email protected]",
  "updatedAt": "2026-05-19T17:00:11.478Z",
  "deletedBy": "[email protected]",
  "deletedAt": "2026-05-19T17:00:11.478Z",
  "isDefault": false
}

Deprecated

Get the cluster's Node Pools.

get

Retrieve all the node pools with details from the cluster by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools instead.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstring · uuidRequired

Unique identifier of the cluster

Responses

200

Node pools returned successfully.

application/json

and

403

Unauthorized

application/json

404

The specified resource was not found

application/json

default

unexpected error

application/json

get

/v1/k8s/clusters/{clusterId}/node-pools

GET /v1/k8s/clusters/{clusterId}/node-pools HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "node-pool-a",
    "overProvisioningRatio": 1,
    "labelKey": "node-type",
    "labelValue": "type-x",
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "binpack"
    }
  },
  {
    "id": 5,
    "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
    "createdAt": "2021-12-14T16:04:15.099Z",
    "updatedAt": "2021-12-14T16:04:15.099Z",
    "deletedAt": "2021-12-14T16:04:15.099Z",
    "status": "Creating",
    "statusMessage": "all nodes are down",
    "nodes": [
      "node-a",
      "node-b"
    ],
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "isDefault": false
  }
]

Deprecated

Create a Node Pool.

post

Use to create a node pool in a cluster by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools instead.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstring · uuidRequired

Unique identifier of the cluster

Body

namestringOptional

Node Pool Name

Example: node-pool-a

overProvisioningRatiointegerOptionalDefault: 1Example: 1

labelKeystringOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type

labelValuestringOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x

Responses

201

Created

400

Bad request.

application/json

409

conflict error

application/json

default

unexpected error

application/json

post

/v1/k8s/clusters/{clusterId}/node-pools

POST /v1/k8s/clusters/{clusterId}/node-pools HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "name": "node-pool-a",
  "overProvisioningRatio": 1,
  "labelKey": "node-type",
  "labelValue": "type-x",
  "placementStrategy": {
    "cpu": "spread",
    "gpu": "binpack"
  }
}

No content

Deprecated

Update labels of a Node Pool.

put

Use to update the labels of a node pool. Deprecated, please use PATCH /api/v1/node-pools/{id} instead.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Body

labelKeystringOptional

key of node label for pool

Example: node-type

labelValuestringOptional

value of node label for pool

Example: type-x

Responses

202

Node Pool update accepted.

400

Bad request.

application/json

403

Unauthorized

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/v1/k8s/clusters/{clusterId}/node-pools/{id}/labels

PUT /v1/k8s/clusters/{clusterId}/node-pools/{id}/labels HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "labelKey": "node-type",
  "labelValue": "type-x"
}

No content

Deprecated

Update a Node Pool.

put

Use to update the details of a node pool by Universally Unique Identifier (UUID). Deprecated, please use PATCH /api/v1/node-pools/{id} instead.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Body

labelKeystringOptional

key of node label for pool

Example: node-type

labelValuestringOptional

value of node label for pool

Example: type-x

overProvisioningRatiointegerOptionalDefault: 1Example: 1

Responses

202

Node Pool update accepted.

400

Bad request.

application/json

403

Unauthorized

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/v1/k8s/clusters/{clusterId}/node-pools/{id}

PUT /v1/k8s/clusters/{clusterId}/node-pools/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "labelKey": "node-type",
  "labelValue": "type-x",
  "overProvisioningRatio": 1,
  "placementStrategy": {
    "cpu": "spread",
    "gpu": "binpack"
  }
}

No content

Deprecated

Delete a Node Pool by id.§

delete

Use to delete a node pool by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools/{id} instead.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Responses

202

Node Pool deletion accepted

400

Bad request.

application/json

403

Unauthorized

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

delete

/v1/k8s/clusters/{clusterId}/node-pools/{id}

DELETE /v1/k8s/clusters/{clusterId}/node-pools/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousReports NextNodes

Last updated 3 months ago