Updates properties for an Apigee environment with patch semantics using a field mask. Note: Not supported for Apigee hybrid.


You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations environments-modify-environment ...

Required Scalar Argument

  • <name> (string)
    • Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{environment}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

  api-proxy-type: string
  created-at: string
  deployment-type: string
  description: string
  display-name: string
  forward-proxy-uri: string
  has-attached-flow-hooks: boolean
  last-modified-at: string
  name: string
    current-aggregate-node-count: int64
    max-node-count: int64
    min-node-count: int64
  state: string
  type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . api-proxy-type=ipsum
    • Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
  • created-at=kasd
    • Output only. Creation time of this environment as milliseconds since epoch.
  • deployment-type=dolore
    • 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
  • description=lorem
    • Optional. Description of the environment.
  • display-name=amet
    • Optional. Display name for this environment.
  • forward-proxy-uri=ipsum
    • 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.
  • has-attached-flow-hooks=false
    • No description provided.
  • last-modified-at=dolores
    • Output only. Last modification time of this environment as milliseconds since epoch.
  • name=consetetur
    • Required. Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
  • node-config current-aggregate-node-count=-15
    • Output only. The current total number of gateway nodes that each environment currently has across all instances.
  • max-node-count=-23
    • 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.
  • min-node-count=-46

    • 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.
  • .. state=takimata

    • Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
  • type=sed
    • Optional. EnvironmentType selected for the environment.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • List of fields to be updated. Fields that can be updated: node_config.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").