# Run Pynt in Postman

{% hint style="success" %}
🚀 **Quick Start**: The easiest way to begin running Pynt in Postman is by using the [**Pynt Postman Wizard**](https://app.pynt.io/onboard/postman/login), which guides you through the integration step-by-step.
{% endhint %}

Running the Pynt collection in Postman is a straightforward process that allows you to perform comprehensive API security testing. This guide will walk you through the steps to execute a Pynt collection, helping you identify vulnerabilities and assess the security posture of your APIs.

***

## Configure Pynt Collection

{% hint style="info" %}
💡 **Postman API Key and Collection Setup**: Configuring the Pynt collection with the **Postman API key** and the reference **collection name/ID** is necessary for Pynt to access your Postman workspace and generate security tests. The API key grants permission for Pynt to interact with your collections, and the collection name/ID ensures that Pynt applies the security tests to the correct API set.
{% endhint %}

**Fill in the required parameters in Pynt's collection:**

* **API-KEY**: Enter your Postman API key under the 'Current Value' column. Generate a key if necessary at [Postman API Keys](https://postman.co/settings/me/api-keys).
* **port**: The port number used in the Docker run command (default: 5001).
* **YOUR-COLLECTION**: The functional test collection name or UID (UID is preferred).
* **scanId**: Output variable (ignore).

{% hint style="info" %}
💡 **Reference App**: Pynt provides a vulnerable app example called 'goat', which you can fork from the [**Pynt public workspace**](https://www.postman.com/pynt-io/workspace/pynt) for testing purposes.
{% endhint %}

***

## Running the Collection

* After filling in the parameters, click **'Save'**.
* If you modify your test collection, re-run the Pynt collection.
* To test another collection, update the **YOUR-COLLECTION** variable and re-run the Pynt collection.

{% hint style="warning" %}
⚠️ **Tip**: Ensure you use the correct API key and accurate collection name or ID to avoid issues while running the collection.
{% endhint %}

***

<figure><img src="/files/GR5aPc5fwqTnKub0O5lD" alt=""><figcaption><p>Image 1 - Generate / Copy API Key if forgotten</p></figcaption></figure>

<figure><img src="/files/wgmGxLCXlkl4UXow6Qgs" alt=""><figcaption><p>Image 2 - Enter 'Pynt' collection parameters</p></figcaption></figure>

<figure><img src="/files/lDVG1geU3EUOPdBdueEy" alt=""><figcaption><p>Image 3 - Run the 'Pynt' collection to generate full OWASP-10 API-security tests for your collection</p></figcaption></figure>

***

{% hint style="info" %}
💡 **Pynt for Postman Troubleshooting**: For problems with Pynt’s Postman integration, check the [**Pynt for Postman Troubleshooting Guide**](https://docs.pynt.io/documentation/api-security-testing/pynt-scans-troubleshooting/pynt-for-postman-troubleshooting) for step-by-step troubleshooting assistance.
{% endhint %}

{% hint style="info" %}
💡 **Still Need Help?** For any questions or troubleshooting, reach out to the [**Pynt Community Support**](https://www.pynt.io/community).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pynt.io/documentation/security-testing-integrations/pynt-with-api-testing-tools/pynt-for-postman/run-pynt-in-postman.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
