v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135982176.0 KB
apps

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)

patch/v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}

Path parameters

appsIdstring required

Part of name. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1.

servicesIdstring required

Part of name. See documentation of appsId.

versionsIdstring required

Part of name. See documentation of appsId.

Query parameters

updateMaskstring

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

Request body

runtimestring

Desired runtime. Example: python27.

envVariablesobject

Environment variables available to the application.Only returned in GET requests if view=FULL is set.

betaSettingsobject

Metadata settings that are supplied to this version to enable beta runtime features.

vmboolean

Whether to deploy this version in a container on a virtual machine.

versionUrlstring

Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly

createdBystring

Output only. Email address of the user who created this version.@OutputOnly

defaultExpirationstring google-duration

Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.

diskUsageBytesstring int64

Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly

namestring

Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly

zonesstring[]

The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.

generatedCustomerMetadataobject

Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest

serviceAccountstring

The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.

idstring

Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".

servingStatus'SERVING_STATUS_UNSPECIFIED' | 'SERVING' | 'STOPPED'

Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.

runtimeMainExecutablePathstring

The path or name of the app's main executable.

buildEnvVariablesobject

Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.

threadsafeboolean

Whether multiple requests can be dispatched to this version at once.

appEngineApisboolean

Allows App Engine second generation runtimes to access the legacy bundled services.

runtimeApiVersionstring

The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref

createTimestring google-datetime

Time that this version was created.@OutputOnly

nobuildFilesRegexstring

Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.

inboundServicesstring[]

Before an application can receive email or XMPP messages, the application must be configured to enable the service.

runtimeChannelstring

The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.

instanceClassstring

Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.

envstring

App Engine execution environment for this version.Defaults to standard.

Response

Successful response