appsId STRING Required

Part of parent. Name of the parent resource to create this version under. Example: apps/myapp/services/default

servicesId STRING Required

Part of parent. See documentation of appsId

defaultExpiration ANY

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

libraries[] OBJECT

Third-party Python runtime library that is required by the application

libraries[].version STRING

Version of the library to select, or "latest"

libraries[].name STRING

Name of the library. Example: "django"

nobuildFilesRegex STRING

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

basicScaling OBJECT

A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity

basicScaling.maxInstances INTEGER

Maximum number of instances to create for this version

basicScaling.idleTimeout ANY

Duration of time after the last request that an instance must wait before the instance is shut down

runtimeMainExecutablePath STRING

The path or name of the app's main executable

runtime STRING

Desired runtime. Example: python27

id STRING

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-"

createdBy STRING

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

envVariables OBJECT

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

envVariables.customKey.value STRING Required

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

livenessCheck OBJECT

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances

livenessCheck.checkInterval ANY

Interval between health checks

livenessCheck.timeout ANY

Time before the check is considered failed

livenessCheck.failureThreshold INTEGER

Number of consecutive failed checks required before considering the VM unhealthy

livenessCheck.initialDelay ANY

The initial delay before starting to execute the checks

livenessCheck.path STRING

The request path

livenessCheck.successThreshold INTEGER

Number of consecutive successful checks required before considering the VM healthy

livenessCheck.host STRING

Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"

network OBJECT

Extra network settings. Only applicable in the App Engine flexible environment

network.sessionAffinity BOOLEAN

Enable session affinity. Only applicable in the App Engine flexible environment

network.forwardedPorts[] STRING

network.instanceTag STRING

Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment

network.subnetworkName STRING

Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application

network.name STRING

Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default

betaSettings OBJECT

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

betaSettings.customKey.value STRING Required

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

env STRING

App Engine execution environment for this version.Defaults to standard

handlers[] OBJECT

URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript

handlers[].staticFiles OBJECT

Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them

handlers[].staticFiles.requireMatchingFile BOOLEAN

Whether this handler should match the request if the file referenced by the handler does not exist

handlers[].staticFiles.expiration ANY

Time a static file served by this handler should be cached by web proxies and browsers

handlers[].staticFiles.applicationReadable BOOLEAN

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas

handlers[].staticFiles.httpHeaders OBJECT

HTTP headers to use for all responses from these URLs

handlers[].staticFiles.httpHeaders.customKey.value STRING Required

HTTP headers to use for all responses from these URLs

handlers[].staticFiles.uploadPathRegex STRING

Regular expression that matches the file paths for all files that should be referenced by this handler

handlers[].staticFiles.path STRING

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern

handlers[].staticFiles.mimeType STRING

MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension

handlers[].redirectHttpResponseCode ENUMERATION

30x code to use when performing redirects for the secure field. Defaults to 302

handlers[].securityLevel ENUMERATION

Security (HTTPS) enforcement for this URL

handlers[].authFailAction ENUMERATION

Action to take when users access resources that require authentication. Defaults to redirect

handlers[].script OBJECT

Executes a script to handle the request that matches the URL pattern

handlers[].script.scriptPath STRING

Path to the script from the application root directory

handlers[].urlRegex STRING

URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path

handlers[].login ENUMERATION

Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment

handlers[].apiEndpoint OBJECT

Uses Google Cloud Endpoints to handle requests

handlers[].apiEndpoint.scriptPath STRING

Path to the script from the application root directory

zones[] STRING

entrypoint OBJECT

The entrypoint for the application

entrypoint.shell STRING

The format should be a shell command that can be fed to bash -c

automaticScaling OBJECT

Automatic scaling is based on request rate, response latencies, and other application metrics

automaticScaling.cpuUtilization OBJECT

Target scaling by CPU usage

automaticScaling.cpuUtilization.aggregationWindowLength ANY

Period of time over which CPU utilization is calculated

automaticScaling.cpuUtilization.targetUtilization NUMBER

Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1

automaticScaling.diskUtilization OBJECT

Target scaling by disk usage. Only applicable in the App Engine flexible environment

automaticScaling.diskUtilization.targetReadBytesPerSecond INTEGER

Target bytes read per second

automaticScaling.diskUtilization.targetReadOpsPerSecond INTEGER

Target ops read per seconds

automaticScaling.diskUtilization.targetWriteOpsPerSecond INTEGER

Target ops written per second

automaticScaling.diskUtilization.targetWriteBytesPerSecond INTEGER

Target bytes written per second

automaticScaling.minPendingLatency ANY

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it

automaticScaling.requestUtilization OBJECT

Target scaling by request utilization. Only applicable in the App Engine flexible environment

automaticScaling.requestUtilization.targetRequestCountPerSecond INTEGER

Target requests per second

automaticScaling.requestUtilization.targetConcurrentRequests INTEGER

Target number of concurrent requests

automaticScaling.maxIdleInstances INTEGER

Maximum number of idle instances that should be maintained for this version

automaticScaling.standardSchedulerSettings OBJECT

Scheduler settings for standard environment

automaticScaling.standardSchedulerSettings.targetThroughputUtilization NUMBER

Target throughput utilization ratio to maintain when scaling

automaticScaling.standardSchedulerSettings.maxInstances INTEGER

Maximum number of instances to run for this version. Set to zero to disable max_instances configuration

automaticScaling.standardSchedulerSettings.minInstances INTEGER

Minimum number of instances to run for this version. Set to zero to disable min_instances configuration

automaticScaling.standardSchedulerSettings.targetCpuUtilization NUMBER

Target CPU utilization ratio to maintain when scaling

automaticScaling.minIdleInstances INTEGER

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service

automaticScaling.maxTotalInstances INTEGER

Maximum number of instances that should be started to handle requests for this version

automaticScaling.minTotalInstances INTEGER

Minimum number of running instances that should be maintained for this version

automaticScaling.networkUtilization OBJECT

Target scaling by network usage. Only applicable in the App Engine flexible environment

automaticScaling.networkUtilization.targetSentBytesPerSecond INTEGER

Target bytes sent per second

automaticScaling.networkUtilization.targetSentPacketsPerSecond INTEGER

Target packets sent per second

automaticScaling.networkUtilization.targetReceivedBytesPerSecond INTEGER

Target bytes received per second

automaticScaling.networkUtilization.targetReceivedPacketsPerSecond INTEGER

Target packets received per second

automaticScaling.maxConcurrentRequests INTEGER

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value

automaticScaling.coolDownPeriod ANY

The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment

automaticScaling.maxPendingLatency ANY

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it

diskUsageBytes INTEGER

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

runtimeChannel STRING

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

healthCheck OBJECT

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment

healthCheck.restartThreshold INTEGER

Number of consecutive failed health checks required before an instance is restarted

healthCheck.healthyThreshold INTEGER

Number of consecutive successful health checks required before receiving traffic

healthCheck.checkInterval ANY

Interval between health checks

healthCheck.timeout ANY

Time before the health check is considered failed

healthCheck.unhealthyThreshold INTEGER

Number of consecutive failed health checks required before removing traffic

healthCheck.disableHealthCheck BOOLEAN

Whether to explicitly disable health checks for this instance

healthCheck.host STRING

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

threadsafe BOOLEAN

Whether multiple requests can be dispatched to this version at once

readinessCheck OBJECT

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation

readinessCheck.checkInterval ANY

Interval between health checks

readinessCheck.timeout ANY

Time before the check is considered failed

readinessCheck.failureThreshold INTEGER

Number of consecutive failed checks required before removing traffic

readinessCheck.appStartTimeout ANY

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic

readinessCheck.path STRING

The request path

readinessCheck.successThreshold INTEGER

Number of consecutive successful checks required before receiving traffic

readinessCheck.host STRING

Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

manualScaling OBJECT

A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time

manualScaling.instances INTEGER

Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function

name STRING

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

apiConfig OBJECT

Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers

apiConfig.script STRING

Path to the script from the application root directory

apiConfig.login ENUMERATION

Level of login required to access this resource. Defaults to optional

apiConfig.url STRING

URL to serve the endpoint at

apiConfig.securityLevel ENUMERATION

Security (HTTPS) enforcement for this URL

apiConfig.authFailAction ENUMERATION

Action to take when users access resources that require authentication. Defaults to redirect

endpointsApiService OBJECT

Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview)

endpointsApiService.name STRING

Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"

endpointsApiService.configId STRING

Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted

endpointsApiService.disableTraceSampling BOOLEAN

Enable or disable trace sampling. By default, this is set to false for enabled

endpointsApiService.rolloutStrategy ENUMERATION

Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted

vm BOOLEAN

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

versionUrl STRING

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

vpcAccessConnector OBJECT

VPC access connector specification

vpcAccessConnector.name STRING

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1

instanceClass STRING

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

servingStatus ENUMERATION

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

runtimeApiVersion STRING

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

deployment OBJECT

Code and application artifacts used to deploy a version to App Engine

deployment.container OBJECT

Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment

deployment.container.image STRING

URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"

deployment.files OBJECT

Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call

deployment.files.customKey OBJECT

Add additional named properties

deployment.files.customKey.sha1Sum STRING

The SHA1 hash of the file, in hex

deployment.files.customKey.mimeType STRING

The MIME type of the file.Defaults to the value from Google Cloud Storage

deployment.files.customKey.sourceUrl STRING

URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//

deployment.cloudBuildOptions OBJECT

Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly

deployment.cloudBuildOptions.cloudBuildTimeout ANY

The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes

deployment.cloudBuildOptions.appYamlPath STRING

Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details

deployment.zip OBJECT

The zip file information for a zip deployment

deployment.zip.filesCount INTEGER

An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow

deployment.zip.sourceUrl STRING

URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//

createTime ANY

Time that this version was created.@OutputOnly

resources OBJECT

Machine resources for a version

resources.volumes[] OBJECT

Volumes mounted within the app container. Only applicable in the App Engine flexible environment

resources.volumes[].volumeType STRING

Underlying volume type, e.g. 'tmpfs'

resources.volumes[].sizeGb NUMBER

Volume size in gigabytes

resources.volumes[].name STRING

Unique name for the volume

resources.diskGb NUMBER

Disk size (GB) needed

resources.cpu NUMBER

Number of CPU cores needed

resources.memoryGb NUMBER

Memory (GB) needed

inboundServices[] ENUMERATION

errorHandlers[] OBJECT

Custom static error page to be served when an error occurs

errorHandlers[].errorCode ENUMERATION

Error condition this handler applies to

errorHandlers[].mimeType STRING

MIME type of file. Defaults to text/html

errorHandlers[].staticFile STRING

Static file content to be served for this error

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors)

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

error.details[] OBJECT

error.details[].customKey.value ANY

metadata OBJECT

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

metadata.customKey.value ANY

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available

response OBJECT

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

response.customKey.value ANY

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}