APIHub
Back to Explore

App Engine Admin API

Provisions and manages developers' App Engine applications.

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1beta/apps/{appsId}/domainMappings/{domainMappingsId}

Gets the specified domain mapping.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
  • domainMappingsId (path, required) — Part of `name`. See documentation of `appsId`.
DELETE

/v1beta/apps/{appsId}/services/{servicesId}

Deletes the specified service and all enclosed versions.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/services/{servicesId}

Gets the current configuration of the specified service.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
POST

/v1beta/apps

Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).

  • parent (query) — The project and location in which the application should be created, specified in the format projects/*/locations/*
GET

/v1beta/apps/{appsId}

Gets information about an application.

  • appsId (path, required) — Part of `name`. Name of the Application resource to get. Example: apps/myapp.
PATCH

/v1beta/apps/{appsId}

Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.

  • appsId (path, required) — Part of `name`. Name of the Application resource to update. Example: apps/myapp.
  • updateMask (query) — Required. Standard field mask for the set of fields to be updated.
GET

/v1beta/apps/{appsId}/authorizedCertificates

Lists all SSL certificates the user is authorized to administer.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
  • view (query) — Controls the set of fields returned in the LIST response.
POST

/v1beta/apps/{appsId}/authorizedCertificates

Uploads the specified SSL certificate.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
DELETE

/v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}

Deletes the specified SSL certificate.

  • appsId (path, required) — Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
  • authorizedCertificatesId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}

Gets the specified SSL certificate.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
  • authorizedCertificatesId (path, required) — Part of `name`. See documentation of `appsId`.
  • view (query) — Controls the set of fields returned in the GET response.
PATCH

/v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

  • appsId (path, required) — Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
  • authorizedCertificatesId (path, required) — Part of `name`. See documentation of `appsId`.
  • updateMask (query) — Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
GET

/v1beta/apps/{appsId}/authorizedDomains

Lists all domains the user is authorized to administer.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
GET

/v1beta/apps/{appsId}/domainMappings

Lists the domain mappings on an application.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
POST

/v1beta/apps/{appsId}/domainMappings

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
  • overrideStrategy (query) — Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
DELETE

/v1beta/apps/{appsId}/domainMappings/{domainMappingsId}

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

  • appsId (path, required) — Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
  • domainMappingsId (path, required) — Part of `name`. See documentation of `appsId`.
PATCH

/v1beta/apps/{appsId}/domainMappings/{domainMappingsId}

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

  • appsId (path, required) — Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
  • domainMappingsId (path, required) — Part of `name`. See documentation of `appsId`.
  • updateMask (query) — Required. Standard field mask for the set of fields to be updated.
GET

/v1beta/apps/{appsId}/firewall/ingressRules

Lists the firewall rules of an application.

  • appsId (path, required) — Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.
  • matchingAddress (query) — A 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 (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
POST

/v1beta/apps/{appsId}/firewall/ingressRules

Creates a firewall rule for the application.

  • appsId (path, required) — Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
DELETE

/v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}

Deletes the specified firewall rule.

  • appsId (path, required) — Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.
  • ingressRulesId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}

Gets the specified firewall rule.

  • appsId (path, required) — Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.
  • ingressRulesId (path, required) — Part of `name`. See documentation of `appsId`.
PATCH

/v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}

Updates the specified firewall rule.

  • appsId (path, required) — Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.
  • ingressRulesId (path, required) — Part of `name`. See documentation of `appsId`.
  • updateMask (query) — Standard field mask for the set of fields to be updated.
POST

/v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

  • appsId (path, required) — Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.
GET

/v1beta/apps/{appsId}/locations

Lists information about the supported locations for this service.

  • appsId (path, required) — Part of `name`. The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
GET

/v1beta/apps/{appsId}/locations/{locationsId}

Gets information about a location.

  • appsId (path, required) — Part of `name`. Resource name for the location.
  • locationsId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

  • appsId (path, required) — Part of `name`. The name of the operation's parent resource.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
GET

/v1beta/apps/{appsId}/operations/{operationsId}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • appsId (path, required) — Part of `name`. The name of the operation resource.
  • operationsId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/services

Lists all the services in the application.

  • appsId (path, required) — Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
PATCH

/v1beta/apps/{appsId}/services/{servicesId}

Updates the configuration of the specified service.

  • appsId (path, required) — Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • migrateTraffic (query) — Set 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/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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).
  • updateMask (query) — Required. Standard field mask for the set of fields to be updated.
GET

/v1beta/apps/{appsId}/services/{servicesId}/versions

Lists the versions of a service.

  • appsId (path, required) — Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.
  • servicesId (path, required) — Part of `parent`. See documentation of `appsId`.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
  • view (query) — Controls the set of fields returned in the List response.
POST

/v1beta/apps/{appsId}/services/{servicesId}/versions

Deploys code and resource files to a new version.

  • appsId (path, required) — Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
  • servicesId (path, required) — Part of `parent`. See documentation of `appsId`.
DELETE

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}

Deletes an existing Version resource.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
  • view (query) — Controls the set of fields returned in the Get response.
PATCH

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}

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/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#manualscaling)

  • appsId (path, required) — Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
  • updateMask (query) — Standard field mask for the set of fields to be updated.
GET

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances

Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

  • appsId (path, required) — Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.
  • servicesId (path, required) — Part of `parent`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `parent`. See documentation of `appsId`.
  • pageSize (query, limit) — Maximum results to return per page.
  • pageToken (query) — Continuation token for fetching the next page of results.
DELETE

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}

Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
  • instancesId (path, required) — Part of `name`. See documentation of `appsId`.
GET

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}

Gets instance information.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
  • instancesId (path, required) — Part of `name`. See documentation of `appsId`.
POST

/v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

  • appsId (path, required) — Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
  • servicesId (path, required) — Part of `name`. See documentation of `appsId`.
  • versionsId (path, required) — Part of `name`. See documentation of `appsId`.
  • instancesId (path, required) — Part of `name`. See documentation of `appsId`.
POST

/v1beta/apps/{appsId}:repair

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

  • appsId (path, required) — Part of `name`. Name of the application to repair. Example: apps/myapp
GET

/v1beta/projects/{projectsId}/locations

Lists information about the supported locations for this service.

  • projectsId (path, required) — Part of `name`. The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
GET

/v1beta/projects/{projectsId}/locations/{locationsId}

Gets information about a location.

  • projectsId (path, required) — Part of `name`. Resource name for the location.
  • locationsId (path, required) — Part of `name`. See documentation of `projectsId`.
POST

/v1beta/projects/{projectsId}/locations/{locationsId}/applications

Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).

  • projectsId (path, required) — Part of `parent`. The project and location in which the application should be created, specified in the format projects/*/locations/*
  • locationsId (path, required) — Part of `parent`. See documentation of `projectsId`.
GET

/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}

Gets information about an application.

  • projectsId (path, required) — Part of `name`. Name of the Application resource to get. Example: apps/myapp.
  • locationsId (path, required) — Part of `name`. See documentation of `projectsId`.
  • applicationsId (path, required) — Part of `name`. See documentation of `projectsId`.
POST

/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:repair

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

  • projectsId (path, required) — Part of `name`. Name of the application to repair. Example: apps/myapp
  • locationsId (path, required) — Part of `name`. See documentation of `projectsId`.
  • applicationsId (path, required) — Part of `name`. See documentation of `projectsId`.
GET

/v1beta/projects/{projectsId}/locations/{locationsId}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

  • projectsId (path, required) — Part of `name`. The name of the operation's parent resource.
  • locationsId (path, required) — Part of `name`. See documentation of `projectsId`.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
GET

/v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • projectsId (path, required) — Part of `name`. The name of the operation resource.
  • locationsId (path, required) — Part of `name`. See documentation of `projectsId`.
  • operationsId (path, required) — Part of `name`. See documentation of `projectsId`.

45 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://appengine.googleapis.com/v1beta/apps/{appsId}/domainMappings/{domainMappingsId}"

appengine.googleapis.com · HTTPS only