Method: organizations.instances.patch

Updates an Apigee runtime instance. You can update the fields described in [NodeConfig][Instance.NodeConfig]. No other fields will be updated.

Note: Not supported for Apigee hybrid.

HTTP request

PATCH https://apigee.googleapis.com/v1/{name=organizations/*/instances/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the instance. Use the following structure in your request:organizations/{org}/instances/{instance}.

Query parameters

Parameters
updateMask

string (FieldMask format)

List of fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofInstance.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.