Batch jobs
Clusters
Environments
Node pools
Node pool bindings
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/environments/{environment_id}:connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection": {
"nodePoolId": "<string>",
"numRanks": 123,
"role": "<string>",
"useLocalStorage": true
},
"vscodeVersion": "<string>"
}
'{}Connect Environment
Connects the environment to a node pool. Returns an error if there is an existing pending connection.
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/environments/{environment_id}:connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection": {
"nodePoolId": "<string>",
"numRanks": 123,
"role": "<string>",
"useLocalStorage": true
},
"vscodeVersion": "<string>"
}
'{}Authorizations
Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>
Path Parameters
The Account Id
The Environment Id
Body
Show child attributes
Show child attributes
The resource id of the node pool the environment is connected to.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank. If not specified, the default is 1.
The ARN of the AWS IAM role that the connection should assume. If not specified, the connection will fall back to the node pool's node_role.
If true, the node's local storage will be mounted on /tmp. This flag has no effect if the node does not have local storage.
Response
A successful response.
The response is of type object.
Was this page helpful?