Skip to main content

Gcp/appengine

@swamp/gcp/appenginev2026.10.29.1· AGPL-3.0-or-later· 2d agoBEHAVIORS
01README

Google Cloud appengine infrastructure models

02Release Notes
  • Updated: apps_services_versions
03Behaviors11
applications_authorizedcertificates.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
certificateRawData?objectUnencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
displayName?stringThe user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount?numberAggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
expireTime?stringThe time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate?objectTime at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
projectsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
locationsIdstringPart of `parent`. See documentation of `projectsId`.
applicationsIdstringPart of `parent`. See documentation of `projectsId`.
fn create()
Create a authorizedCertificates
fn get(identifier: string)
Get a authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
fn update(identifier?: string)
Update authorizedCertificates attributes
ArgumentTypeDescription
identifier?stringTarget a specific authorizedCertificates by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
fn sync(identifier?: string)
Sync authorizedCertificates state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific authorizedCertificates by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List authorizedCertificates resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
view?stringControls the set of fields returned in the LIST response.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An SSL certificate that a user has been authorized to administer. A user is a...
applications_authorizeddomains.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
projectsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
locationsIdstringPart of `parent`. See documentation of `projectsId`.
applicationsIdstringPart of `parent`. See documentation of `projectsId`.
fn get(identifier: string)
Get a authorizedDomains
ArgumentTypeDescription
identifierstringThe name of the authorizedDomains
fn sync(identifier?: string)
Sync authorizedDomains state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific authorizedDomains by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List authorizedDomains resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A domain that a user has been authorized to administer. To authorize use of a...
applications_domainmappings.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
id?stringRelative name of the domain serving the application. Example: example.com.
sslSettings?objectID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
projectsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
locationsIdstringPart of `parent`. See documentation of `projectsId`.
applicationsIdstringPart of `parent`. See documentation of `projectsId`.
overrideStrategy?stringWhether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
fn create()
Create a domainMappings
fn get(identifier: string)
Get a domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
fn update(identifier?: string)
Update domainMappings attributes
ArgumentTypeDescription
identifier?stringTarget a specific domainMappings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
fn sync(identifier?: string)
Sync domainMappings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific domainMappings by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List domainMappings resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A domain serving an App Engine application.
apps.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
authDomain?stringGoogle Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
databaseType?enumThe type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultCookieExpiration?stringCookie expiration policy for this application.
dispatchRules?arrayDomain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
featureSettings?objectBoolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap?objectWhether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
id?stringIdentifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
locationId?stringLocation from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name?string
serviceAccount?stringThe service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
servingStatus?enumServing status of this application.
sslPolicy?enumThe SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite
fn create()
Create a apps
fn get(identifier: string)
Get a apps
ArgumentTypeDescription
identifierstringThe name of the apps
fn update(identifier?: string)
Update apps attributes
ArgumentTypeDescription
identifier?stringTarget a specific apps by name (e.g. one discovered by list)
fn sync(identifier?: string)
Sync apps state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific apps by name (e.g. one discovered by list)
fn list_runtimes(environment?: any)
list runtimes
ArgumentTypeDescription
environment?any
fn repair()
repair

Resources

state(infinite)— An Application resource contains the top-level configuration of an App Engine...
apps_authorizedcertificates.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
certificateRawData?objectUnencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
displayName?stringThe user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount?numberAggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
expireTime?stringThe time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate?objectTime at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
appsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
fn create()
Create a authorizedCertificates
fn get(identifier: string)
Get a authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
fn update(identifier?: string)
Update authorizedCertificates attributes
ArgumentTypeDescription
identifier?stringTarget a specific authorizedCertificates by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
fn sync(identifier?: string)
Sync authorizedCertificates state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific authorizedCertificates by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List authorizedCertificates resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
view?stringControls the set of fields returned in the LIST response.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An SSL certificate that a user has been authorized to administer. A user is a...
apps_authorizeddomains.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
fn get(identifier: string)
Get a authorizedDomains
ArgumentTypeDescription
identifierstringThe name of the authorizedDomains
fn sync(identifier?: string)
Sync authorizedDomains state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific authorizedDomains by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List authorizedDomains resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A domain that a user has been authorized to administer. To authorize use of a...
apps_domainmappings.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
id?stringRelative name of the domain serving the application. Example: example.com.
sslSettings?objectID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
appsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
overrideStrategy?stringWhether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
fn create()
Create a domainMappings
fn get(identifier: string)
Get a domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
fn update(identifier?: string)
Update domainMappings attributes
ArgumentTypeDescription
identifier?stringTarget a specific domainMappings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
fn sync(identifier?: string)
Sync domainMappings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific domainMappings by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List domainMappings resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A domain serving an App Engine application.
apps_firewall_ingressrules.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
action?enumThe action to take on matched requests.
description?stringAn optional string description of this rule. This field has a maximum length of 400 characters.
priority?number
sourceRange?stringIP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
appsIdstringPart of `parent`. Required. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
fn create()
Create a ingressRules
fn get(identifier: string)
Get a ingressRules
ArgumentTypeDescription
identifierstringThe name of the ingressRules
fn update(identifier?: string)
Update ingressRules attributes
ArgumentTypeDescription
identifier?stringTarget a specific ingressRules by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the ingressRules
ArgumentTypeDescription
identifierstringThe name of the ingressRules
fn sync(identifier?: string)
Sync ingressRules state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific ingressRules by name (e.g. one discovered by list)
fn list(matchingAddress?: string, pageSize?: number, maxPages?: number)
List ingressRules resources
ArgumentTypeDescription
matchingAddress?stringA valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn batch_update(ingressRules?: any)
batch update
ArgumentTypeDescription
ingressRules?any

Resources

state(infinite)— A single firewall rule that is evaluated against incoming traffic and provide...
apps_services.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
id?stringOutput only. Relative name of the service within the application. Example: default.@OutputOnly
labels?recordA set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
name?stringOutput only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
networkSettings?objectThe ingress settings for version or service.
split?objectMapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
appsIdstringPart of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default.
migrateTraffic?stringSet to true 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 both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
fn get(identifier: string)
Get a services
ArgumentTypeDescription
identifierstringThe name of the services
fn update(identifier?: string)
Update services attributes
ArgumentTypeDescription
identifier?stringTarget a specific services by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the services
ArgumentTypeDescription
identifierstringThe name of the services
fn sync(identifier?: string)
Sync services state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific services by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List services resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Service resource is a logical component of an application that can share st...
apps_services_versions.tsv2026.10.29.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
apiConfig?objectAction to take when users access resources that require authentication. Defaults to redirect.
appEngineApis?booleanAllows App Engine second generation runtimes to access the legacy bundled services.
appEngineBundledServices?arrayList of specific App Engine Bundled Services that are enabled for this Version.
automaticScaling?objectThe 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.
basicScaling?objectDuration of time after the last request that an instance must wait before the instance is shut down.
betaSettings?recordMetadata settings that are supplied to this version to enable beta runtime features.
buildEnvVariables?recordEnvironment variables available to the build environment.Only returned in GET requests if view=FULL is set.
createTime?stringTime that this version was created.@OutputOnly
defaultExpiration?stringDuration 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.
deployment?objectPath 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.
endpointsApiService?objectEndpoints 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.
entrypoint?objectThe format should be a shell command that can be fed to bash -c.
env?stringApp Engine execution environment for this version.Defaults to standard.
envVariables?recordEnvironment variables available to the application.Only returned in GET requests if view=FULL is set.
errorHandlers?arrayError condition this handler applies to.
flexibleRuntimeSettings?objectThe operating system of the application runtime.
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
handlers?arrayPath to the script from the application root directory.
healthCheck?objectInterval between health checks.
id?stringRelative 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-".
inboundServices?arrayBefore an application can receive email or XMPP messages, the application must be configured to enable the service.
instanceClass?stringInstance 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.
libraries?arrayName of the library. Example: "django".
livenessCheck?objectInterval between health checks.
manualScaling?objectNumber 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.
network?objectList of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
nobuildFilesRegex?stringFiles 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.
readinessCheck?objectA maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
resources?objectNumber of CPU cores needed.
runtime?stringDesired runtime. Example: python27.
runtimeApiVersion?stringThe 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
runtimeChannel?stringThe channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
runtimeMainExecutablePath?stringThe path or name of the app's main executable.
serviceAccount?stringThe 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.
servingStatus?enumCurrent 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.
threadsafe?booleanWhether multiple requests can be dispatched to this version at once.
vm?booleanWhether to deploy this version in a container on a virtual machine.
vpcAccess?objectOptional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK}
vpcAccessConnector?objectThe egress setting for the connector, controlling what traffic is diverted through it.
zones?arrayThe Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
appsIdstringPart of `parent`. Required. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
servicesIdstringPart of `parent`. See documentation of `appsId`.
fn create()
Create a versions
fn get(identifier: string)
Get a versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn update(identifier?: string)
Update versions attributes
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
fn sync(identifier?: string)
Sync versions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific versions by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List versions resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
view?stringControls the set of fields returned in the List response.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn export_app_image(destinationRepository?: any)
export app image
ArgumentTypeDescription
destinationRepository?any

Resources

state(infinite)— A Version resource is a specific set of source code and configuration files t...
apps_services_versions_instances.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appsIdstringPart of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
servicesIdstringPart of `name`. See documentation of `appsId`.
versionsIdstringPart of `name`. See documentation of `appsId`.
fn get(identifier: string)
Get a instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn delete(identifier: string)
Delete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
fn sync(identifier?: string)
Sync instances state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific instances by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List instances resources
ArgumentTypeDescription
pageSize?numberMaximum results to return per page.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn debug(sshKey?: any)
debug
ArgumentTypeDescription
sshKey?any

Resources

state(infinite)— An Instance resource is the computing unit that App Engine uses to automatica...
04Previous Versions19
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.10.13.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.10.06.1
  • Updated: apps, apps_authorizedcertificates, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, applications_authorizedcertificates, applications_domainmappings

Modified 1 behaviors

2026.09.07.1
  • Updated: apps, apps_services
2026.08.12.2
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.29.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.24.1
  • Updated: apps_services_versions
2026.07.21.3
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.21.1
  • Updated: apps, apps_authorizedcertificates, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, applications_authorizedcertificates, applications_domainmappings
2026.07.20.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.19.2
  • Updated: apps_authorizeddomains, apps_services, apps_services_versions_instances, applications_authorizeddomains
2026.07.19.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.18.2
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.07.17.2
  • Updated: apps, apps_authorizedcertificates, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, applications_authorizedcertificates, applications_domainmappings
2026.07.17.1
  • Updated: apps_domainmappings, applications_domainmappings
2026.06.08.2
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.06.07.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
2026.05.25.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings

Modified 1 behaviors

2026.05.24.1
  • Updated: apps, apps_authorizedcertificates, apps_authorizeddomains, apps_domainmappings, apps_firewall_ingressrules, apps_services, apps_services_versions, apps_services_versions_instances, applications_authorizedcertificates, applications_authorizeddomains, applications_domainmappings
05Stats
A
100 / 100
Downloads
35
Archive size
135.9 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels