Method: apps.services.patch

Updates the configuration of the specified service.

HTTP request

PATCH https://appengine.googleapis.com/v1beta/{name=apps/*/services/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the resource to update. Example:apps/myapp/services/default.

Authorization requires the followingIAM permission on the specified resourcename:

  • appengine.services.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Standard field mask for the set of fields to be updated.

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

migrateTraffic

boolean

Set totrue to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for bothwarmup requests andautomatic scaling. You must specify theshardBy field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, seeMigrating and Splitting Traffic.

Request body

The request body contains an instance ofService.

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

For more information, see theAuthentication Overview.

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-06-16 UTC.