PATCH
/
v1
/
accounts
/
{account_id}
/
environments
/
{environment_id}

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

baseImageRef
string

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

connection
object

Information about the current environment connection.

displayName
string
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.

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.

Response

200 - application/json
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.

baseImageRef
string

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

connection
object

Information about the current environment connection.

createdBy
string

The email address of the user who created this environment.

createTime
string

The creation time of the environment.

displayName
string
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.

name
string
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.

snapshotImageRef
string

The URI of the latest container image snapshot for 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.