Manage API deployments to Apigee in Postman

Apigee X enables developers to manage access to their APIs by abstracting services behind a secure proxy layer. Once connected to Apigee X, you can view your API deployment status and history from within Postman.

Postman supports connecting to organizations and proxies hosted in Apigee X. Postman doesn't support connecting to Apigee Edge.

Creating a service account and private key

When setting up the connection to Apigee, you need to enter a service account email and a private key. You can create the required items in your Google Cloud project. Follow the steps below to add a custom role, create a service account, and generate a private key.

To create a custom role, do the following:

  1. Log on to the Google Cloud Platform console and go to your project settings.

  2. Select Roles in the left navigation pane, and then select + Create Role.

  3. Enter the required details for the role, and then select + Add permissions.

  4. Select the checkbox next to the following permission properties (enter a property name to locate it in the list):

    • apigee.deployments.list
    • apigee.environments.list
    • apigee.environments.get
    • apigee.organizations.list
    • apigee.organizations.get
    • apigee.proxies.list
    • apigee.proxies.get
    • apigee.proxyrevisions.get
  5. Select Add and verify that you added the correct permissions to the role.

  6. Select Create to finish creating the custom role.

Adding a custom role

To create a service account, do the following:

  1. Select Service Accounts in the left navigation pane.

  2. Select + Create Service Account.

  3. Enter the required details for the service account and select Create and Continue.

  4. In the Role drop-down list, select the custom role you created (enter the custom role name to locate it in the list).

    Postman recommends adding a custom role to the service account. If you can't add a custom role, you can instead add the Apigee API Reader role and the Apigee Environment Admin role to the service account.

  5. Select Done to finish creating the service account.

Creating a service account

To generate a private key, do the following:

  1. Select the new service account to open it and select the Keys tab.
  2. Select Add key and select Create new key.
  3. Select the JSON key type and select Create.
Generating a private key

Your browser will automatically download a JSON file that has values for client_email and a private_key. You will use these values when connecting Postman to Apigee X.

Connecting to Apigee X

To connect to Apigee X in Postman, select APIs in the sidebar and select an API. Select Deployments, and then select Apigee X.

To authenticate with Apigee X, do the following:

  1. Enter the Service Account Email and Private Key. You can find the values in the JSON file you downloaded.

    Instead of manually entering the keys, you can upload the JSON file that has your service account email and private key. The values will be automatically populated.

  2. Select Connect.

Apigee X authentication

To set up the connection to Apigee X, do the following:

  1. Select the Organization that has the proxy you want to connect to Postman.
  2. Enter a Nickname for this integration.
  3. Select the API Proxy that you want to connect to your API in Postman.
  4. Select one or more Environments where you deploy your API in Apigee X.
  5. Select Complete Setup.
Apigee X setup

Viewing Apigee X deployments

After connecting to Apigee X, you can view the deployment status and history for your API definitions in Postman. Select APIs in the sidebar and select an API. Select Deployments.

  • For your API proxy, you can view the latest revision, source, creation date, and date last updated.
  • For each proxy endpoint, you can view the name and base paths.
  • For each Apigee environment, you can view the description, date last updated, status, deployed revision, and deployment date.
Viewing API deployments

From the Deployments view, you can take the following actions:

  • To view your API proxy in Apigee X, select the Latest Revision or a Deployed Revision.
  • To view performance metrics for your API proxy in Apigee X, select API Metrics.
  • To see the latest deployment status, select the refresh icon Refresh icon.
  • To edit or delete the connection to Apigee X, select the more actions icon More actions icon.

Last modified: 2022/09/15