Investigate API Postman Collection

Overview

Postman is an API development and client request platform. You can view, set up, and run the Umbrella Investigate API request samples as a collection in Postman.

Prerequisites

  • Postman for desktop or Postman app
  • Umbrella Investigate API token
  • Umbrella Investigate API Postman collection and environment

Install Postman

  1. Download Postman for desktop or the Postman desktop agent. The Postman app requires the Postman Desktop agent. For more information, see Download Postman.
  2. Install Postman for desktop or the Postman desktop agent. For more information, see Postman Installation and Updates.

Import Postman Collections and Environments

Within your instance of Postman, create a Postman workspace. You can import the Cisco Cloud Security Postman collections into the Postman workspace.

To import a collection, select the Postman Import tab. After the Import dialog window displays, click the Code repository tab to upload the Umbrella Investigate API collection from GitHub into Postman.

You can find the Cloud Security Postman Examples in the Cisco DevNet Cloud Security GitHub repository. To view the Investigate API Postman Collection and Environment, navigate to Investigate API.

Set Up a Request

To run an Umbrella Investigate API request, open the Investigate API collection within a workspace.

  1. Locate a folder and request in the collection. For example, locate the domains > categorization folder and select the GET Domains Categorization request.
  2. Create the Umbrella Investigate API access token. For more information, see Generate API Token.

Configure Postman Environment

The Investigate API collection shares a Postman environment. The Investigate API Postman environment includes the base URI, path parameter, and access token fields.

To open the Investigate Postman environment configuration panel, select the Postman Environment quick look (eye icon). Substitute your Investigate API access token in the token field.

The Investigate Postman environment defines the baseUrl field:

https://investigate.api.umbrella.com

Authorization

The Investigate API collection defines the Authorization type and token field for all requests in the collection. You can override this authorization token setting for any request.

  1. In the Postman Authorization tab, set the Type drop-down list item to Bearer Token.
  2. The Token field is set to the value of the token field in the Investigate API Postman environment.

Run a Request

In Postman, confirm the values of the request and path parameters. Then, run the request.

  1. Select the GET Domains Categorization request.
  2. Set a domain name in the domain field in the Investigate API Postman environment.
  3. Click Send.

Troubleshoot a Request

  • Verify the token and baseUrl fields in the Investigate API Postman environment.
  • In the Postman console, you can view the request logs and error messages.