Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Creates an environment in an organization.

post/v1/{+parent}/environments

Path parameters

parentstring required

Required. Name of the organization in which the environment will be created. Use the following structure in your request: organizations/{org}

Query parameters

namestring

Optional. Name of the environment.

Request body

type'ENVIRONMENT_TYPE_UNSPECIFIED' | 'BASE' | 'INTERMEDIATE' | 'COMPREHENSIVE'

Optional. EnvironmentType selected for the environment.

deploymentType'DEPLOYMENT_TYPE_UNSPECIFIED' | 'PROXY' | 'ARCHIVE'

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

forwardProxyUristring

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 only supported scheme is "http". 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.

createdAtstring int64

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

lastModifiedAtstring int64

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

namestring

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

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING'

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

descriptionstring

Optional. Description of the environment.

apiProxyType'API_PROXY_TYPE_UNSPECIFIED' | 'PROGRAMMABLE' | 'CONFIGURABLE'

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

displayNamestring

Optional. Display name for this environment.

hasAttachedFlowHooksboolean

Response

Successful response