References - Postman Starter Collection for ThreatConnect API

Owned by Tianyi Chen
Last updated: Jul 11, 2023
4 min read

Postman is a great tool for crafting and managing API calls. This article will explore how to import and configure the ThreatConnect API Starter Collection.

Setting up Postman

  1. Download Postman:

    1. https://www.postman.com/downloads/

  2. Installing Postman:

    1. https://learning.postman.com/docs/getting-started/installation-and-updates/

Importing and Configuring the ThreatConnect API Starter Collection

  1. Download the ThreatConnect API V2 Starter Collection below. It is a Postman collection version 2.1 json file.

The V3 starter collection can be found here:

 

2. Open the Postman Application and navigate to the import button at the top left hand corner.

3. An import menu screen will popup. Click on “Upload Files” located in the center of the popup.

4. Select the ThreatConnect API Start Collection as the desired file to import. Click the orange “Import” button.

5. The ThreatConnect API Starter Collection should now be visible under your collections tab.

6. Edit the ThreatConnect API Starter Collection by clicking on the … icon located at the bottom right hand corner of the collection. Click on “Edit” from the menu.

7. Once inside the Edit Collection popup, click on the “Variables” tab.

8. Enter the tc_access_id and tc_secret_key for the API user.

  • If an API user has not been created for your organization, login to the ThreatConnect Instance and navigate to the “Org Settings” page.

    • You should see an option to “Create API User”. If the option is not available, please check to see if an API user has already been created by looking at the users shown on the page. Otherwise, please contact ThreatConnect Technology Partners on Slack.

    • When creating your API user, the API user’s Access ID and Secret Key will be shown. Note that the secret key is only shown once and so it is a good idea to store it in a safe place for future use. Click the “SAVE” button to save the API user.

  • If an API user exists already, click on the pencil icon under the “Options” column to see the Access ID. The Secret Key will not be shown. If the Secret Key was not saved, it is recommended to delete the current API user and create another one.

  • Enter the Access ID as the value of the tc_access_id variable and the Secret Key as the value for the tc_secret_key variable. These values should be put under the “CURRENT VALUE” section as shown below. Click the orange “Update” button located at the lower right hand corner of the popup.

9. Now the collection is ready to use. Navigate to any of the API calls from the collection and hit the blue “Send” button. API Calls from this collection should now return with a “status”: “Success”.

 

  • If the query returns “status”: ”Failure”, there are two quick checks to do.

    • 1. Make sure that the Access ID and Secret Key are correctly entered.

    • 2. Make sure that the Access ID and Secret Key are entered in the Current Value section and not the Initial Value section in the variables tab in the collection settings.