Batch jobs
Clusters
Environments
Node pools
Node pool bindings
curl --request GET \
--url https://api.fireworks.ai/v1/accounts/{account_id}/environments \
--header 'Authorization: Bearer <token>'{
"environments": [
{
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"state": "STATE_UNSPECIFIED",
"status": {
"code": "OK",
"message": "<string>"
},
"connection": {
"nodePoolId": "<string>",
"numRanks": 123,
"role": "<string>",
"zone": "<string>",
"useLocalStorage": true
},
"baseImageRef": "<string>",
"imageRef": "<string>",
"snapshotImageRef": "<string>",
"shared": true,
"annotations": {},
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"totalSize": 123
}List Environments
curl --request GET \
--url https://api.fireworks.ai/v1/accounts/{account_id}/environments \
--header 'Authorization: Bearer <token>'{
"environments": [
{
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"state": "STATE_UNSPECIFIED",
"status": {
"code": "OK",
"message": "<string>"
},
"connection": {
"nodePoolId": "<string>",
"numRanks": 123,
"role": "<string>",
"zone": "<string>",
"useLocalStorage": true
},
"baseImageRef": "<string>",
"imageRef": "<string>",
"snapshotImageRef": "<string>",
"shared": true,
"annotations": {},
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"totalSize": 123
}Authorizations
Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>
Path Parameters
The Account Id
Query Parameters
The maximum number of environments to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.
A page token, received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.
Only environments satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.
A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "name".
The fields to be returned in the response. If empty or "*", all fields will be returned.
Response
A successful response.
Show child attributes
Show child attributes
The creation time of the environment.
The email address of the user who created this environment.
The current state of the environment.
STATE_UNSPECIFIED, CREATING, DISCONNECTED, CONNECTING, CONNECTED, DISCONNECTING, RECONNECTING, DELETING The current error status of the environment.
Show child attributes
Show child attributes
The status code.
OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, DATA_LOSS A developer-facing error message in English.
Information about the current environment connection.
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.
Current for the last zone that this environment is connected to. We want to warn the users about cross zone migration latency when they are connecting to node pool in a different zone as their persistent volume.
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.
The URI of the base container image used for this environment.
The URI of the container image used for this environment. This is a image is an immutable snapshot of the base_image_ref when the environment was created.
The URI of the latest container image snapshot for this environment.
Whether the environment is shared with all users in the account. This allows all users to connect, disconnect, update, delete, clone, and create batch jobs using the environment.
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.
Show child attributes
Show child attributes
The update time for the environment.
A token, which can be sent as page_token to retrieve the next page.
If this field is omitted, there are no subsequent pages.
The total number of environments.
Was this page helpful?