Prerequisites for Running Pynt Scans

Discover the prerequisites needed to seamlessly onboard with Pynt.

At a Glance: 🛠️ Before running Pynt scans, ensure your environment is correctly set up with the required system configurations, permissions, and tools for a smooth and successful API security scan.

System Requirements

• Docker Installed & Running: If you're running Pynt locally, ensure Docker is installed and running. Install Docker here.

• Python Installed: If using Pynt locally, make sure Python is installed on your machine.

• GHCR Image Access: Ensure you can pull images from the GHCR repository.

If you have trouble pulling images, follow the steps provided in the guide for accessing the public registry.

Network Access

• Pynt Domain Accessible: Verify that app.pynt.io is reachable from the machine running Pynt.

Integration with Postman

• Postman Installed: If you're integrating Pynt with Postman, ensure you're using the Postman app (note: Pynt requires Docker access and doesn’t support the Postman web interface).

Functional Tests

• Functional Tests Required: For several integrations, Pynt uses your existing functional tests (Postman, Newman, CLI) to drive its security scans. Ensure your functional test collection is available, your environment variables are set, and the target application is running.

• Ensure everything is working by running your functional tests against the target application before executing Pynt’s security tests.

🔧 Pro tip: Pynt utilizes your functional tests to inform the security tests it runs. The broader and more comprehensive your functional tests, the more security coverage Pynt will provide. More APIs, users, and requests mean richer security testing!