# 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="https://3462681674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZKwBF6q0tAGXlIih38HL%2Fuploads%2FQx4edMaFAv85g9NLuiWd%2FAPIKey.png?alt=media&#x26;token=e93775e5-1aa0-4b64-9a3f-5aab5014063f" alt=""><figcaption><p>Image 1 - Generate / Copy API Key if forgotten</p></figcaption></figure>

<figure><img src="https://3462681674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZKwBF6q0tAGXlIih38HL%2Fuploads%2FA8APuejdtsl5e1eZajP1%2FPyntVariables.png?alt=media&#x26;token=f92c6a47-7f6e-42c0-93d1-6435a953d19f" alt=""><figcaption><p>Image 2 - Enter 'Pynt' collection parameters</p></figcaption></figure>

<figure><img src="https://3462681674-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZKwBF6q0tAGXlIih38HL%2Fuploads%2F0aB0urfax074DCbBt9as%2FRunPyntCollection.png?alt=media&#x26;token=26301fa0-03eb-494f-af05-47911bc6bcfa" 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 %}
