Google is committed to advancing racial equity for Black communities. See how.

Tutorial: Using extensions

An extension is a kind of bridge between your API proxies and an external resource. This tutorial shows you what an extension is, and guides you through the following processes:

  • Create an extension
  • Add it to your organization
  • (Extra credit) Log a message flow variable
  • Add it to your API proxy


Before you start this tutorial, make sure you've done all of the following:

Area What needs doing Done?
New Edge experience Apigee must enable the extensions feature for your Apigee Public Cloud organization. If it is, you will see an Extensions menu item in the Admin menu of the New Edge experience.

If not, please contact Apigee Support.

Google Cloud Platform
  1. Create a project on Google Cloud Platform, if you don't already have one. Your API proxy will write log entries using this project.
  2. Enable Stackdriver logging for your Google Cloud Platform (GCP) project, as described in Creating a Stackdriver account.
Service Account
  1. Create or choose a GCP Service Account (SA) with which we'll authenticate to GCP. You can create an SA in the GCP console at IAM & Admin > Service accounts.
  2. Assign the "Logs Writer" role to the SA in Logging > Logs Writer. For more information, see Granting roles to a service account for specific resources.
  3. Download an SA JSON file for configuring the extension. For more information see Creating and managing service account keys.

Ready? Let's begin!

To use extensions with Apigee Edge:

  1. Step 1: Add an extension to Edge.
  2. Step 2: Configure and deploy for testing.
  3. Step 3: Use an ExtensionCallout policy.
  4. Step 4: Deploy your proxy.
  5. Step 5: Log a message flow variable.