REST Resource: organizations.environments

{
  "name": string,
  "description": string,
  "createdAt": string,
  "lastModifiedAt": string,
  "properties": {
    object (Properties)
  },
  "displayName": string,
  "state": enum (State),
  "deploymentType": enum (DeploymentType),
  "apiProxyType": enum (ApiProxyType),
  "nodeConfig": {
    object (NodeConfig)
  },
  "forwardProxyUri": string,
  "type": enum (EnvironmentType),
  "hasAttachedFlowHooks": boolean
}

string

Required. Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$

string

Optional. Description of the environment.

string (int64 format)

Output only. Creation time of this environment as milliseconds since epoch.

string (int64 format)

Output only. Last modification time of this environment as milliseconds since epoch.

object (Properties)

Optional. Key-value pairs that may be used for customizing the environment.

string

Optional. Display name for this environment.

enum (State)

Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.

enum (DeploymentType)

Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including:

• Managing the deployment of API proxy or shared flow revisions
• Creating, updating, or deleting resource files
• Creating, updating, or deleting target servers

enum (ApiProxyType)

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

object (NodeConfig)

Optional. NodeConfig of the environment.

string

Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.

To remove a forward proxy setting, update the field to an empty value.

Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.

enum (EnvironmentType)

Optional. EnvironmentType selected for the environment.

boolean

{
  "minNodeCount": string,
  "maxNodeCount": string,
  "currentAggregateNodeCount": string
}

string (int64 format)

Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

string (int64 format)

Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.

string (int64 format)

Output only. The current total number of gateway nodes that each environment currently has across all instances.