Patch v1+name — apigateway

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13152654.3 KB

projects

Updates the parameters of a single ApiConfig.

patch/v1/{+name}

Path parameters

namestring required

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

Query parameters

updateMaskstring

Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Request body

createTimestring google-datetime

Output only. Created time.

displayNamestring

Optional. Display name.

updateTimestring google-datetime

Output only. Updated time.

namestring

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

gatewayServiceAccountstring

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

Output only. State of the API Config.

labelsobject

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

serviceConfigIdstring

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

Response

Successful response