Manage API deployments to Azure API Management in Postman

Azure API Management enables developers to deploy API gateways for APIs hosted in Microsoft Azure, other cloud platforms, or on-premises. Once connected to Azure API Management, you can view your API deployment status and history from within Postman. You can also export your OpenAPI definition from Postman to Azure API Management, or import a definition from Azure to use it in Postman.

Connecting to Azure API Management

1. Select APIs in the sidebar and select an API.

2. Select Deployments, and then select Microsoft Azure.

3. You'll be prompted to authorize Postman to access your Microsoft Azure account. After you grant access, you can close the browser tab and return to Postman.

4. Enter information about the Azure API Management service you want to connect to your API:

   • Subscription - The subscription where the service was created.
   • Resource Group - The resource group that contains the service.
   • Service - The Azure API Management service instance used for deploying your API.
   • API Version - The Azure API version that corresponds to your API in Postman.

5. To connect more Azure API Management services, select + Add Service. To remove a service, select Remove.

6. When you're finished adding services, select Connect.

   

7. If you want, you can choose to import a definition from Azure API Management:

   • To import a definition, select the Definition type (OpenAPI 2.0 or OpenAPI 3.0). Then select the Azure service to import the definition from and select Import. Importing a definition will replace your current API definition or add a new definition if one doesn't exist.
   • If you don't want to import a definition, select Maybe later. You can import a definition at any time after connecting to Azure API Management.
   

Viewing Azure API deployments

After connecting to Azure API Management, you can view the deployment status and history for your API definition in Postman. Select APIs in the sidebar and select an API, then select Deployments.

For each connected API Management service instance, you can view the resource group, location, subscription, and virtual IP address (VIP).

Select a service to view more details about the connected Azure API version.

• Revisions - Revisions enable you make and test changes to your API without affecting consumers. For each revision, you can view the revision ID, date created, description, URL, and Postman source.

  • Use the Online toggle to set a revision to offline or online. Consumers can't access an offline revision.
  • Use the Current toggle to make a revision the current revision for your API. Enter an optional description and select Confirm. Consumers access the current revision when calling the API.

• Changelog - The changelog shows the deployment history for your API. Each time you make a revision current, Postman adds an entry to the changelog, including the date created, the date last updated, and a description of the change.

• Export History - The export history lists all exports from Postman for this API. For each export, you can view the date created, the Azure revision, and the Postman source.

From the service details view, you can take the following actions:

• Use the dropdown list to view a different Azure API Management service instance.
• To export your definition to Azure, select Export API. Learn more about exporting your API.
• To import a definition from Azure, select Import Definition. Learn more about importing a definition.
• To see the latest deployment status, select the refresh icon .
• To edit or delete the connection to Azure API management, select the more actions icon .
• To open the gateway URL of the API management service, select the Gateway URL link.
• To open the developer portal for the API management service, select View Developer Portal.

Importing a definition from Azure

You can import a definition from a connected Azure API Management service to your API in Postman. Importing a definition will replace your current API definition or add a new definition if one doesn't exist.

1. Select APIs in the sidebar and select an API.
2. Select Deployments, and then select Import Definition.
3. Select the Definition type (OpenAPI 2.0 or OpenAPI 3.0).
4. Select the Azure service to import the definition from.
5. Select Import.

Exporting your API to Azure API Management

Exporting an OpenAPI definition makes it available in the connected Azure API Management service. OpenAPI 2.0 and 3.0 definitions are supported. You can export the definition to an existing revision or to a new revision.

1. Select APIs in the sidebar and select an API.

2. Select Deployments.

3. Select the service you want to export to, and then select Export API.

4. Select the source of the definition you want to export. You can select the current definition or any published version of the definition.

5. Enter a brief description for the export.

6. (Optional) If you want to export the definition to an existing revision, select the checkbox. Select the Revision ID of the revision you want to update.

   If you don't select the checkbox, Postman exports the API to a new revision.

7. Select Export.

After exporting, you can use the Current toggle to make the new or updated revision the current revision.

Troubleshooting export issues

If you have problems exporting your definition, check the following:

• Some definition fields (such as name, description, and protocols) must be updated on the current revision and can't be updated on other revisions. To update these fields on revisions that aren't the current revision, perform a manual merge instead.

• Some properties of the OpenAPI specification aren't supported by Azure API Management. For more information, see the Microsoft help article API import restrictions and known issues.