Provision API hub using the UI

This page applies to Apigee and Apigee hybrid.

This document describes how to provision API hub using the user interface (UI). This is the recommended method for Provisioning API hub; however, you can also provision API hub using the command line.

Summary of steps

The provisioning steps are as follows:

  1. Verify that you have met the API hub prerequisites (except for the steps in the Software row).
  2. Open API hub and select your Google Cloud project.
  3. Enable APIs. Apigee requires you to enable a few Google Cloud APIs.
  4. Specify a Hosting location. You must specify the physical location of your API hub.
  5. Specify or create a CMEK. Because information about internal APIs may be considered sensitive, Apigee requires a CMEK to encrypt and decrypt (protect) data at rest. The CMEK must be in the same region as the Hosting location.
  6. Wait 30 minutes for provisioning to complete.

Provisioning steps

To launch the API hub provisioning wizard:

  1. Ensure that you have met the prerequisites described in API hub prerequisites.

  2. In the Google Cloud console, go to the API hub page.

    Go to API hub

  3. Select your project:

    project selector, click for larger image project selector, click for larger image

  4. If your project has not yet been provisioned for API hub, Start with Apigee API hub is displayed. Click Get started.

    get started, click for larger image get started

  5. The provisioning wizard starts:

    enable APIs, click for larger image enable APIs

  6. Click Enable APIs. This step takes a few seconds to complete.

  7. For Hosting location, select a Region, for example, us-central1.

    hosting location, click for larger image hosting location

  8. Click Set location.

  9. For Encryption, click Choose a customer-managed encryption key.

    provision encryption, click for larger image provision encryption

  10. If you already have a CMEK, you can select it, otherwise click Create key. Create a new key is displayed.

    provision create key, click for larger image provision create key

  11. Select Create key ring.

    provision create key ring name, click for larger image provision create key ring name

  12. Type a Key ring name.
  13. Select a Key ring location. This location is restricted to the hosting location you chose in the previous step to ensure that the key and data remain in the same region.
  14. Click Continue.

  15. Type a Key name.

    provision create key name, click for larger image provision create key name

  16. Select a Protection level, for example, Software.
  17. Click Continue.

  18. If the Review page looks correct, click Create.

    provision review, click for larger image provision review

  19. Click Confirm encryption key.

    provision confirm encryption key, click for larger image provision confirm encryption key

  20. Click Create service identity & grant permissions.

    provision create service identity, click for larger image provision create service identity

  21. Click Submit.

    provision submit, click for larger image provision submit

  22. Finalizing your registry is displayed. It takes about 30 minutes to provision.

    provision status, click for larger image provision status

  23. When provisioning is complete, Your registry is ready displays.

    provision ready, click for larger image provision ready

Next steps

See Next steps for some tips on how to get started using API hub.