Overview and prerequisites

This section describes the prequisites and process for installing and configuring Apigee with a non-evaluation account. Alternatively, you can install and configure a limited evaluation version (Beta). For more information, see Pricing.


Before you can set up and deploy API proxies with Apigee, you must meet the following prerequisites:

Done? Prerequisite Description
Google Cloud billing account

You must have a Google Cloud account with active billing. This applies whether you want to set up a production organization or an evaluation organization. While an evaluation organization does not itself incur any charges against your account, some APIs used by the organization do; for example, the Compute Engine API.

For more information, see Create a new billing account.

Google Cloud project Create a new Cloud project (sometimes referred to as a GCP project). When you do, be sure to note the project ID and project number. You'll need the ID and number later in this process.

For more information, see Creating and managing projects.


Install the following software on your administrative machine:

After you satisfy the prerequisites, it's time to install and configure Apigee.

Installation and configuration process

This section describes the overall process for setting up and configuring Apigee so that you can then create and deploy your very own API proxy.

Do not proceed until you have satisfied the prerequisites.

The general process for setting up and configuring Apigee is as follows:

  1. Define environment variables so that you can follow along with the documentation. (And do a lot less typing.)
  2. Enable APIs. Without these, Apigee services wouldn't be able to talk to one another or other services.
  3. Create an organization which will encompass all of your environments and groups, users, API proxies, and related resources.
  4. Configure service networking to allocate IP addresses for your private connection between your project and the Google services.
  5. Create a runtime that hosts your project and its API proxies. It connects to Google via a private peered VPC network.
  6. Create an environment and an environment group, and then attach the group to your runtime.
  7. Configure routing so that you can access your new cluster and the API proxy deployed on it.
  8. Deploy sample proxy and see how it all ties together.

Each step is described in detail in the sections that follow.

Let's Go!

About the Apigee provisioning wizard

Apigee provides you with the Apigee provisioning wizard, which performs many of the tedious and error prone aspects of setting up and configuring Apigee for you. However, even with the wizard, there are still some steps where you need to use gcloud and other command line tools.

About the examples

Some commands and examples in the documentation use curl to connect to the Apigee APIs. In most cases, we use the following guidelines:

  • Include the -i option to display the request and response headers.
  • Avoid the -s option, as this suppresses errors that might provide useful information.
  • Where possible, use local environment variables to ensure consistency and accuracy. When using environment variables, however, be sure to wrap them in the proper quotation marks.
  • Set the Content-Type header to "application/json", which indicates that the data payload is in JSON format.