App Engine Admin API
Provisions and manages developers' App Engine applications.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provisions and manages developers' App Engine applications.
Endpoints 59
apps
- POSTCreates an App Engine application for a Google Cloud Platform project
/v1/appsCreates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The… - GETGets information about an application.
/v1/apps/:appsId?includeExtraData=INCLUDE_EXTRA_DATA_UNSPECIFIEDGets information about an application. - PATCHUpdates the specified Application resource
/v1/apps/:appsId?updateMask=stringUpdates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the… - GETLists all the available runtimes for the application.
/v1/apps/:appsId:listRuntimes?environment=ENVIRONMENT_UNSPECIFIEDLists all the available runtimes for the application. - POSTRecreates the required App Engine features for the specified App Engine application, for example a Cloud Storage…
/v1/apps/:appsId:repairRecreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use…
apps.authorizedCertificates
- GETLists all SSL certificates the user is authorized to administer.
/v1/apps/:appsId/authorizedCertificates?pageSize=0&pageToken=string&view=BASIC_CERTIFICATELists all SSL certificates the user is authorized to administer. - POSTUploads the specified SSL certificate.
/v1/apps/:appsId/authorizedCertificatesUploads the specified SSL certificate. - GETGets the specified SSL certificate.
/v1/apps/:appsId/authorizedCertificates/:authorizedCertificatesId?view=BASIC_CERTIFICATEGets the specified SSL certificate. - DELETEDeletes the specified SSL certificate.
/v1/apps/:appsId/authorizedCertificates/:authorizedCertificatesIdDeletes the specified SSL certificate. - PATCHUpdates the specified SSL certificate
/v1/apps/:appsId/authorizedCertificates/:authorizedCertificatesId?updateMask=stringUpdates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The…
apps.authorizedDomains
- GETLists all domains the user is authorized to administer.
/v1/apps/:appsId/authorizedDomains?pageSize=0&pageToken=stringLists all domains the user is authorized to administer.
apps.domainMappings
- GETLists the domain mappings on an application.
/v1/apps/:appsId/domainMappings?pageSize=0&pageToken=stringLists the domain mappings on an application. - POSTMaps a domain to an application
/v1/apps/:appsId/domainMappings?overrideStrategy=UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGYMaps 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… - GETGets the specified domain mapping.
/v1/apps/:appsId/domainMappings/:domainMappingsIdGets the specified domain mapping. - DELETEDeletes the specified domain mapping
/v1/apps/:appsId/domainMappings/:domainMappingsIdDeletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. - PATCHUpdates the specified domain mapping
/v1/apps/:appsId/domainMappings/:domainMappingsId?updateMask=stringUpdates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A…
apps.firewall.ingressRules
- POSTReplaces the entire firewall ruleset in one bulk operation
/v1/apps/:appsId/firewall/ingressRules:batchUpdateReplaces 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… - GETLists the firewall rules of an application.
/v1/apps/:appsId/firewall/ingressRules?matchingAddress=string&pageSize=0&pageToken=stringLists the firewall rules of an application. - POSTCreates a firewall rule for the application.
/v1/apps/:appsId/firewall/ingressRulesCreates a firewall rule for the application. - GETGets the specified firewall rule.
/v1/apps/:appsId/firewall/ingressRules/:ingressRulesIdGets the specified firewall rule. - DELETEDeletes the specified firewall rule.
/v1/apps/:appsId/firewall/ingressRules/:ingressRulesIdDeletes the specified firewall rule. - PATCHUpdates the specified firewall rule.
/v1/apps/:appsId/firewall/ingressRules/:ingressRulesId?updateMask=stringUpdates the specified firewall rule.
apps.locations
- GETGets information about a location.
/v1/apps/:appsId/locations/:locationsIdGets information about a location. - GETLists information about the supported locations for this service.This method lists locations based on the resource…
/v1/apps/:appsId/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service.This method lists locations based on the resource scope provided in the…
apps.operations
- GETGets the latest state of a long-running operation
/v1/apps/:appsId/operations/:operationsIdGets 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. - GETLists operations that match the specified filter in the request
/v1/apps/:appsId/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
apps.services
- GETGets the current configuration of the specified service.
/v1/apps/:appsId/services/:servicesIdGets the current configuration of the specified service. - DELETEDeletes the specified service and all enclosed versions.
/v1/apps/:appsId/services/:servicesIdDeletes the specified service and all enclosed versions. - PATCHUpdates the configuration of the specified service.
/v1/apps/:appsId/services/:servicesId?migrateTraffic=true&updateMask=stringUpdates the configuration of the specified service. - GETLists all the services in the application.
/v1/apps/:appsId/services?pageSize=0&pageToken=stringLists all the services in the application.
apps.services.versions
- GETLists the versions of a service.
/v1/apps/:appsId/services/:servicesId/versions?pageSize=0&pageToken=string&view=BASICLists the versions of a service. - POSTDeploys code and resource files to a new version.
/v1/apps/:appsId/services/:servicesId/versionsDeploys code and resource files to a new version. - GETGets the specified Version resource
/v1/apps/:appsId/services/:servicesId/versions/:versionsId?view=BASICGets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource. - DELETEDeletes an existing Version resource.
/v1/apps/:appsId/services/:servicesId/versions/:versionsIdDeletes an existing Version resource. - PATCHUpdates the specified Version resource
/v1/apps/:appsId/services/:servicesId/versions/:versionsId?updateMask=stringUpdates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version… - POSTExports a user image to Artifact Registry.
/v1/apps/:appsId/services/:servicesId/versions/:versionsId:exportAppImageExports a user image to Artifact Registry.
apps.services.versions.instances
- POSTEnables debugging on a VM instance
/v1/apps/:appsId/services/:servicesId/versions/:versionsId/instances/:instancesId:debugEnables 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",… - GETGets instance information.
/v1/apps/:appsId/services/:servicesId/versions/:versionsId/instances/:instancesIdGets instance information. - DELETEStops a running instance.The instance might be automatically recreated based on the scaling settings of the version
/v1/apps/:appsId/services/:servicesId/versions/:versionsId/instances/:instancesIdStops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances… - GETLists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring…
/v1/apps/:appsId/services/:servicesId/versions/:versionsId/instances?pageSize=0&pageToken=stringLists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API…
projects.locations.applications
- PATCHUpdates the specified Application resource
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId?updateMask=stringUpdates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the…
projects.locations.applications.authorizedCertificates
- GETLists all SSL certificates the user is authorized to administer.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedCertificates?pageSize=0&pageToken=string&view=BASIC_CERTIFICATELists all SSL certificates the user is authorized to administer. - POSTUploads the specified SSL certificate.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedCertificatesUploads the specified SSL certificate. - GETGets the specified SSL certificate.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedCertificates/:authorizedCertificatesId?view=BASIC_CERTIFICATEGets the specified SSL certificate. - DELETEDeletes the specified SSL certificate.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedCertificates/:authorizedCertificatesIdDeletes the specified SSL certificate. - PATCHUpdates the specified SSL certificate
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedCertificates/:authorizedCertificatesId?updateMask=stringUpdates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The…
projects.locations.applications.authorizedDomains
- GETLists all domains the user is authorized to administer.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/authorizedDomains?pageSize=0&pageToken=stringLists all domains the user is authorized to administer.
projects.locations.applications.domainMappings
- GETLists the domain mappings on an application.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/domainMappings?pageSize=0&pageToken=stringLists the domain mappings on an application. - POSTMaps a domain to an application
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/domainMappings?overrideStrategy=UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGYMaps 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… - GETGets the specified domain mapping.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/domainMappings/:domainMappingsIdGets the specified domain mapping. - DELETEDeletes the specified domain mapping
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/domainMappings/:domainMappingsIdDeletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. - PATCHUpdates the specified domain mapping
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/domainMappings/:domainMappingsId?updateMask=stringUpdates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A…
projects.locations.applications.services
- DELETEDeletes the specified service and all enclosed versions.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesIdDeletes the specified service and all enclosed versions. - PATCHUpdates the configuration of the specified service.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId?migrateTraffic=true&updateMask=stringUpdates the configuration of the specified service.
projects.locations.applications.services.versions
- DELETEDeletes an existing Version resource.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId/versions/:versionsIdDeletes an existing Version resource. - PATCHUpdates the specified Version resource
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId/versions/:versionsId?updateMask=stringUpdates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version… - POSTExports a user image to Artifact Registry.
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId/versions/:versionsId:exportAppImageExports a user image to Artifact Registry.
projects.locations.applications.services.versions.instances
- POSTEnables debugging on a VM instance
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId/versions/:versionsId/instances/:instancesId:debugEnables 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",… - DELETEStops a running instance.The instance might be automatically recreated based on the scaling settings of the version
/v1/projects/:projectsId/locations/:locationsId/applications/:applicationsId/services/:servicesId/versions/:versionsId/instances/:instancesIdStops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances…
API details
- Base URL
https://appengine.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter - Operations
- 59 operations on 35 pathsGET 24POST 13PATCH 11DELETE 11
- Main resources
- apps.firewall.ingressRules 6apps.services.versions 6apps 5apps.authorizedCertificates 5apps.domainMappings 5projects.locations.applications.authorizedCertificates 5projects.locations.applications.domainMappings 5apps.services 4apps.services.versions.instances 4projects.locations.applications.services.versions 3
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the App Engine Admin API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the App Engine Admin API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Creates an App Engine application for a Google Cloud Platform project” (POST /v1/apps), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the App Engine Admin API?
Provisions and manages developers' App Engine applications. It is listed under Developer tools and has 59 endpoints.
Who publishes the App Engine Admin API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the App Engine Admin API?
Requests go to https://appengine.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the App Engine Admin API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.
How many endpoints does the App Engine Admin API have?
59 operations on 35 paths (24 GET, 13 POST, 11 PATCH, 11 DELETE). The largest groups are apps.firewall.ingressRules, apps.services.versions, apps, apps.authorizedCertificates.
Is forking the App Engine Admin API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.