Before you begin

This page applies to Apigee, but not to Apigee hybrid.

View Apigee Edge documentation.

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:

    VALID NAMES        INVALID NAMES
    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.

Software

Install the following software on your administrative machine:

Permissions The individual who provisions Apigee must have or be granted certain Google Cloud IAM permissions to be successful. For details, see About Apigee provisioning permissions.