> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulsedive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrate with Postman

> Fork Pulsedive's public Postman collection to send Pulsedive API requests without building them from scratch.

[Postman](https://www.postman.com/) is an API client used to build, test, and send API requests.
Pulsedive provides a public Postman workspace with a pre-built collection of API requests, so you can start making calls without writing any code.

## What's Available

The **Pulsedive API** collection holds seven requests that cover indicator and threat lookups, Explore queries, and scanning, each with example values filled in.

* **Info - Indicator ID**: Retrieves an indicator by its Pulsedive indicator ID.
* **Info - Indicator Name**: Retrieves an indicator by its value, such as a domain.
* **Info - Threat Name**: Retrieves a threat by its name.
* **Explore - Query**: Runs an Explore query and returns the matching indicators.
* **Explore - Query CSV Export**: Runs an Explore query and returns the results as CSV.
* **Analyze Indicator - Add to Queue**: Adds an indicator to Pulsedive's queue for scanning.
* **Analyze Indicator - Retrieve Results**: Retrieves the result of a queued scan by its queue ID.

> [!WARNING]
>
> **Analyze Indicator - Add to Queue** arrives with its `probe` parameter set to `1`, which requests an active scan.
> Set `probe` to `0` for a passive scan, which collects data without contacting the indicator.
> To learn what each scan type does, visit [Analyze](https://docs.pulsedive.com/api/scan/overview.md).

## Getting Started

Fork the collection into your own workspace and add your API key once, so every request sends it for you.

To use the collection, you need a Pulsedive API key and a Postman account.
Find your API key on your [Pulsedive account page](https://pulsedive.com/account).

**1. Fork the collection**

Create your own copy of the collection, so you have somewhere to save your API key.

1. Open the [Pulsedive API collection](https://www.postman.com/pulsedive/pulsedive/collection/gm2bj9o/pulsedive-api) and sign in to Postman.

2. Hover over the collection in the sidebar and select **View more actions** > **Use / Fork**.

3. Under **Workspace**, select the workspace for your copy.

   > [!WARNING]
   >
   > Choose a workspace that only you or your team can open, because your copy holds your API key.

4. Leave **Use as** set to **Fork**, then select **Use Collection**.

**2. Add your API key**

Save your key to the collection's authorization settings, so every request inherits it.
Postman's web app and desktop app store the key differently, so follow the tab for the app you use.

> [tab] Web app
>
> 1. In your fork, select the collection and open its **Authorization** tab.
>
>    > [!NOTE]
>    >
>    > **Auth Type** is already set to **API Key**, with **Key** set to `key` and **Add to** set to **Query Params**.
>    > Leave all three as they are.
>
> 2. Enter your Pulsedive API key in **Value**, then select **Save**.
>    Postman stores the key as a secret variable and replaces it in the field with a reference that begins `{{auth_secret_`.
>
> 3. Open the collection's **Variables** tab.
>
> 4. On the row that begins `auth_secret`, select the lock icon, then select **Not a secret**.
>    Postman shows your key in the **Value** column.
>
>    > [!WARNING]
>    >
>    > A request sent while the variable is still a secret goes out without your key and still returns `200 OK`.
>    > Complete this step before you rely on a response.

> [tab] Desktop app
>
> 1. In your fork, select the collection and open its **Authorization** tab.
> 2. Enter your Pulsedive API key in **Value**.
> 3. Save the collection.
>    On macOS, press `[Cmd]` + `[S]`.
>    On Windows and Linux, press `[Ctrl]` + `[S]`.
>
>    Postman keeps your key in the **Value** field and sends it with every request.
>
>    > [!NOTE]
>    >
>    > Postman marks the key as a sensitive value and offers **Set as Variable**.
>    > Leave the key in the field to finish here, because **Set as Variable** continues into Postman's vault.

**3. Verify your key**

Confirm that Postman sends your key, because Pulsedive also answers requests that arrive without one.

1. Open the **Console** at the bottom of the Postman window.
2. Open **Info - Indicator Name** and select **Send**.
3. In the Console, confirm that the request URL ends with `key=` followed by your API key.

   > [!TIP]
   >
   > If nothing follows `key=`, Postman sent the request without your key.
   > In the web app, check that you selected **Not a secret** for the variable on the **Variables** tab.

> [!NOTE]
>
> The **Console** and the **Variables** tab show your API key in plain text, so leave them out of any screenshot you share.

To learn what each request returns, visit [API](https://docs.pulsedive.com/api/overview.md).
To build your own Explore queries, visit [Explore](https://docs.pulsedive.com/api/explore/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.