Creating App Engine Applications with the Admin API

Use the Google App Engine Admin API to programmatically create App Engine applications in new Google Cloud Platform projects. By using both the Admin API along with the Cloud Resource Manager API, you are able to programmatically manage GCP projects and App Engine applications.

Creating an App Engine application creates an Application resource for a target GCP project in the specified location.

To manually create an App Engine application in a GCP project, see the Managing Projects, Applications, and Billing topic for your language in either the standard environment or flexible environment.

Before you begin

You must meet the following prerequisites before you can create an App Engine application using the Admin API:

  • You must create or have an existing GCP project.
  • You must be the owner of the target GCP project.
  • You must be able to access the Admin API.

Before any other user account can perform tasks on an App Engine application, the GCP project owner must first create the Application resource. For example, you must create the App Engine application before a user account with the App Engine Deployer role can deploy an app using a service account.

To create a GCP project:

API

To programmatically create a GCP project, you can use the Cloud Resource Manager API, see Creating a New Project for details. See a short example.

Console

To create create a GCP project using the GCP Console:

Go to the Projects page

gcloud

After installing the Google Cloud SDK, you can run the following command of the gcloud tool to create a GCP project:

gcloud projects create

If you choose to use an existing GCP project, you must ensure that the project does not already contain the Application resource because projects support only a single App Engine application. To check if your GCP project already contains the Application resource, you can use either the apps.get method or run the gcloud app describe command.

Creating an App Engine application

To create an App Engine application with the Admin API:

  1. Authorize your HTTP requests, for example obtain an access token.

    Authorizing access to the Admin API can be accomplished with different OAuth flows depending on the needs of your API app. For more information, see Accessing the API.

  2. Send an HTTP POST request using your access token and the Admin API to create an App Engine application.

    You define the Application resource and target GCP project in the HTTP POST request, for example:

    POST https://appengine.googleapis.com/v1/apps { "id": "[MY_PROJECT_ID]", "locationId": "[MY_APP_LOCATION]" }
    

    Required HTTP request fields:

    • id: The project ID of the target GCP project in which you want to create an App Engine application.

    • locationId: This is the geographic region in which the App Engine application is located and runs, for example:

      • us-central (for us-central1)
      • us-east1
      • us-east4
      • southamerica-east1
      • europe-west (for europe-west1)
      • europe-west2
      • europe-west3
      • asia-northeast1
      • asia-south1
      • australia-southeast1

      For a complete list of supported locations, you can use the apps.locations.list method.

      Example: Authorize and execute this example request in the APIs Explorer to view a current list of supported locations.

    See Application resource for the complete list of field options.

    Example cURL command:

    curl -X POST -d "{ 'id': '[MY_PROJECT_ID]', 'locationId': '[MY_APP_LOCATION]' }" -H "Content-Type: application/json" -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps
    

    Where:

    • [MY_PROJECT_ID] is the ID of target project where you want to create your App Engine application.
    • [MY_APP_LOCATION] is the location where you want to create your App Engine application.
    • [MY_ACCESS_TOKEN] is the access token that you obtained to authorize your HTTP requests.

    Example response:

    {
      "name": "apps/[MY_PROJECT_ID]/operations/0a37a032-be3f-4c20-98b4-e3300447450f",
      "metadata": {
        "@type": "type.googleapis.com/google.appengine.v1.OperationMetadataV1",
        "method": "google.appengine.v1.Applications.CreateApplication",
        "insertTime": "2016-10-03T20:48:02.099Z",
        "user": "me@example.com",
        "target": "apps/[MY_PROJECT_ID]"
      }
    }
    
  3. Verify that your App Engine application was created:

    1. View the status of the actual creation operation:

      The HTTP POST request that you used in the previous step returned the operation name in the name field, which you use with the GET method of the apps.operations collection to check the status of the creation operation.

      For example, if the name field of the response is:

      "name": "apps/[MY_PROJECT_ID]/operations/0a37a032-be3f-4c20-98b4-e3300447450f"
      

      Then you send the following HTTP GET request:

      GET https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/operations/0a37a032-be3f-4c20-98b4-e3300447450f
      

      Example cURL command:

      curl -X GET -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/operations/0a37a032-be3f-4c20-98b4-e3300447450f
      

      Where [MY_ACCESS_TOKEN] is your access token and [MY_PROJECT_ID] is the ID of target project.

      Example response:

      {
        "name": "apps/[MY_PROJECT_ID]/operations/0a37a032-be3f-4c20-98b4-e3300447450f",
        "metadata": {
          "@type": "type.googleapis.com/google.appengine.v1.OperationMetadataV1",
          "method": "google.appengine.v1.Applications.CreateApplication",
          "insertTime": "2016-10-03T20:48:02.099Z",
          "endTime": "2016-10-03T20:48:18.272Z",
          "user": "me@example.com",
          "target": "apps/[MY_PROJECT_ID]"
        },
        "done": true,
        "response": {
          "@type": "type.googleapis.com/google.appengine.v1.Application",
          "id": "[MY_PROJECT_ID]",
          "locationId": "[MY_APP_LOCATION]"
        }
      }
      
    2. Verify that the App Engine application was created in your project:

      To view details about the version, you use the GET method of the apps collection. You must specify the project that you deployed in the HTTP GET request, for example:

      GET https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]
      

      Example cURL command:

      curl -X GET -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/
      

      Where [MY_ACCESS_TOKEN] is your access token and [MY_PROJECT_ID] is the ID of target project.

      Example response:

      {
        "name": "apps/[MY_PROJECT_ID]",
        "id": "[MY_PROJECT_ID]",
        "authDomain": "gmail.com",
        "locationId": "us-central",
        "defaultHostname": "[MY_PROJECT_ID].appspot.com",
        "defaultBucket": "[MY_PROJECT_ID].appspot.com"
      }
      

What's next

Send feedback about...

App Engine Admin API