Introduction to provisioning

You're viewing Apigee X documentation.
View Apigee Edge documentation.

This section describes the prequisites and process for installing and configuring Apigee with either an eval organization or a paid (non-evaluation) organization. The term provisioning is just a fancy term for installing and configuring an org.

This section contains important information about Apigee orgs and the prerequisites for provisioning one.

Provisioning options

Before you begin, we recommend that you review the differences between Eval and Paid organizations, as described in Comparing eval and paid organizations. Then, choose the most appropriate method for you for provisioning an org:

Method Description Next Step
Apigee provisioning wizard
  • Easiest
  • Less prone to error
  • Some details are hidden or obfuscated by the wizard
Command line instructions
  • High level of control
  • No hidden tasks -- you do them all
Apigee Trial Provisioning Script
  • One step: define the values; the script does the rest
  • Does not support Windows

If you want to skip directly to the procedures, click one of the following:


To provision an eval org:

Click Here



To provision a paid org:

Click Here


Differences between eval and paid orgs

  • Eval orgs are time-limited and lack the scalability and flexibility of paid (or production) orgs. For more about the differences between the account/organization types, see Organization types.
  • The location for your cluster with an eval account must be a zone and not a region. This is also known as the instance location. As a result, the runtime location should be in the form us-west1-a (a zone, which is within a region), for example, rather than us-west1 (a region which contains zones). Note, however, that analytics data storage locations for both eval and paid orgs should be regions.
  • While an eval org is free and does not require a paid plan, some aspects of the installation require a Google Cloud billing account (such as enabling the Compute Engine API).
  • When using the UI to provision your org, eval orgs have fewer options during the process.

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 provision a production or 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 Google Cloud 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.

Project names must adhere to the following guidelines:

  • Start with a lower-case letter. For example, my-org is OK, but _my-org is not.
  • Include the following characters only:
    [a-z]   Lower-case letters
    [0-9]   Numbers
    -       Hyphens

    For example:

    my-project         my_project        No underscores
    first-project      1st-project       Cannot start with a number
    google-project     project@google    No special chars except hyphens

For more information, see Creating a project.


Install the following software on your administrative machine:

  • Google Cloud SDK (required for command line; recommended for UI-based installations)
  • curl (optional but strongly suggested)

There are additional prerequisites for accessing your API proxy after the installation. For example, you might need to create a new Google Compute Engine VM or an external load balancer. But we're getting ahead of ourselves. Those are discussed later.

Next steps

After you satisfy the prerequisites, it's time to install and configure Apigee. Select one of the following:


To provision an eval org:

Eval Org



To provision a paid org:

Paid Org