POST
/
v1
/
accounts
/
{account_id}
/
nodePools
curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/nodePools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "nodePool": {
    "displayName": "<string>",
    "minNodeCount": 123,
    "maxNodeCount": 123,
    "overprovisionNodeCount": 123,
    "eksNodePool": {
      "nodeRole": "<string>",
      "instanceType": "<string>",
      "spot": true,
      "nodeGroupName": "<string>",
      "subnetIds": [
        "<string>"
      ],
      "zone": "<string>",
      "placementGroup": "<string>",
      "launchTemplate": "<string>"
    },
    "fakeNodePool": {
      "machineType": "<string>",
      "numNodes": 123,
      "serviceAccount": "<string>"
    },
    "annotations": {}
  },
  "nodePoolId": "<string>"
}'
{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "minNodeCount": 123,
  "maxNodeCount": 123,
  "overprovisionNodeCount": 123,
  "eksNodePool": {
    "nodeRole": "<string>",
    "instanceType": "<string>",
    "spot": true,
    "nodeGroupName": "<string>",
    "subnetIds": [
      "<string>"
    ],
    "zone": "<string>",
    "placementGroup": "<string>",
    "launchTemplate": "<string>"
  },
  "fakeNodePool": {
    "machineType": "<string>",
    "numNodes": 123,
    "serviceAccount": "<string>"
  },
  "annotations": {},
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "nodePoolStats": {
    "nodeCount": 123,
    "ranksPerNode": 123,
    "environmentCount": 123,
    "environmentRanks": 123,
    "batchJobCount": {},
    "batchJobRanks": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The Account Id

Body

application/json
​
nodePool
object
required

The properties of the NodePool being created.

​
nodePoolId
string
required

Response

200 - application/json
A successful response.
​
name
string
​
displayName
string

Human-readable display name of the node pool. e.g. "My Node Pool" Must be fewer than 64 characters long.

​
createTime
string

The creation time of the node pool.

​
minNodeCount
integer

Minimum number of nodes in this node pool. Must be a non-negative integer less than or equal to max_node_count. If not specified, the default is 0.

​
maxNodeCount
integer

Maximum number of nodes in this node pool. Must be a positive integer greater than or equal to min_node_count. If not specified, the default is 1.

​
overprovisionNodeCount
integer

The number of nodes to overprovision by the autoscaler. Must be a non-negative integer and less than or equal to min_node_count and max_node_count-min_node_count. If not specified, the default is 0.

​
eksNodePool
object
​
fakeNodePool
object

A fake node pool to be used with FakeCluster.

​
annotations
object

Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.

​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the node pool.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
DELETING,
FAILED
​
status
object

Contains detailed message when the last node pool operation fails, e.g. when node pool is in FAILED state or when last node pool update fails.

​
nodePoolStats
object

Live statistics of the node pool.

Was this page helpful?

Suggest edits
Get Node PoolUpdate Node Pool