Sign in

v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22216424765.0 KB
gateway.openapi_Gateway

Get Environment

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

Path parameters

account_idstring required

The Account Id

environment_idstring required

The Environment Id

Query parameters

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time

The creation time of the environment.

createdBystring

The email address of the user who created this environment.

state'STATE_UNSPECIFIED' | 'CREATING' | 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED' | 'DISCONNECTING' | 'RECONNECTING' | 'DELETING'
  • CREATING: The environment is being created.
  • DISCONNECTED: The environment is not connected.
  • CONNECTING: The environment is being connected to a node.
  • CONNECTED: The environment is connected to a node.
  • DISCONNECTING: The environment is being disconnected from a node.
  • RECONNECTING: The environment is reconnecting with new connection parameters.
  • DELETING: The environment is being deleted.
baseImageRefstring

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

imageRefstring

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.

snapshotImageRefstring

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

sharedboolean

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.

annotationsobject

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.

updateTimestring date-time

The update time for the environment.