PATCH
/
v1
/
accounts
/
{account_id}
/
environments
/
{environment_id}
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/environments/{environment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "baseImageRef": "<string>",
  "shared": true,
  "annotations": {}
}'
{
  "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": {}
}

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

​
environment_id
string
required

The Environment Id

Body

application/json
The properties of the Environment being updated. `environment.name` must be populated with the updated resource's name.
​
displayName
string
​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the environment.

Available options:
STATE_UNSPECIFIED,
CREATING,
DISCONNECTED,
CONNECTING,
CONNECTED,
DISCONNECTING,
RECONNECTING,
DELETING
​
status
object

The current error status of the environment.

​
connection
object

Information about the current environment connection.

​
baseImageRef
string

The URI of the base container image used for this environment.

​
shared
boolean

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.

​
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.

Response

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

The creation time of the environment.

​
createdBy
string

The email address of the user who created this environment.

​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the environment.

Available options:
STATE_UNSPECIFIED,
CREATING,
DISCONNECTED,
CONNECTING,
CONNECTED,
DISCONNECTING,
RECONNECTING,
DELETING
​
status
object

The current error status of the environment.

​
connection
object

Information about the current environment connection.

​
baseImageRef
string

The URI of the base container image used for this environment.

​
imageRef
string

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.

​
snapshotImageRef
string

The URI of the latest container image snapshot for this environment.

​
shared
boolean

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.

​
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.

Was this page helpful?

Suggest edits
Get EnvironmentConnect Environment