REST Resource: organizations.environments

Resource: Environment

JSON representation
{
  "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
}
Fields
name

string

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

description

string

Optional. Description of the environment.

createdAt

string (int64 format)

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

lastModifiedAt

string (int64 format)

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

properties

object (Properties)

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

displayName

string

Optional. Display name for this environment.

state

enum (State)

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

deploymentType

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
apiProxyType

enum (ApiProxyType)

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

nodeConfig

object (NodeConfig)

Optional. NodeConfig of the environment.

forwardProxyUri

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.

type

enum (EnvironmentType)

Optional. EnvironmentType selected for the environment.

hasAttachedFlowHooks

boolean

DeploymentType

Deployment type, proxy or archive, supported by the environment.

Enums
DEPLOYMENT_TYPE_UNSPECIFIED Deployment type not specified.
PROXY Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
ARCHIVE Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.

NodeConfig

NodeConfig for setting the min/max number of nodes associated with the environment.

JSON representation
{
  "minNodeCount": string,
  "maxNodeCount": string,
  "currentAggregateNodeCount": string
}
Fields
minNodeCount

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.

maxNodeCount

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.

currentAggregateNodeCount

string (int64 format)

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

EnvironmentType

Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments.

Enums
ENVIRONMENT_TYPE_UNSPECIFIED Environment type not specified.
BASE This is the default type. Base environment has limited capacity and capabilities and are usually used when you are getting started with Apigee or while experimenting. Refer to Apigee's public documentation for more details.
INTERMEDIATE Intermediate environment supports API management features and higher capacity than Base environment. Refer to Apigee's public documentation for more details.
COMPREHENSIVE Comprehensive environment supports advanced capabilites and even higher capacity than Intermediate environment. Refer to Apigee's public documentation for more details.

Methods

create

Creates an environment in an organization.

delete

Deletes an environment from an organization.

get

Gets environment details.

getAddonsConfig

Gets the add-ons config of an environment.

getApiSecurityRuntimeConfig

Gets the API Security runtime configuration for an environment.

getDebugmask

Gets the debug mask singleton resource for an environment.

getIamPolicy

Gets the IAM policy on an environment.

getSecurityActionsConfig

GetSecurityActionConfig returns the current SecurityActions configuration.

getTraceConfig

Get distributed trace configuration in an environment.

list

Lists all environments in an organization.

modifyEnvironment

Updates properties for an Apigee environment with patch semantics using a field mask.

setIamPolicy

Sets the IAM policy on an environment, if the policy already exists it will be replaced.

testIamPermissions

Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment.

update

Updates an existing environment.

updateDebugmask

Updates the debug mask singleton resource for an environment.

updateEnvironment

Updates an existing environment.

updateSecurityActionsConfig

UpdateSecurityActionConfig updates the current SecurityActions configuration.

updateTraceConfig

Updates the trace configurations in an environment.