Documentation
  • ๐ŸปIntro
    • Why API Security is Critical?
    • Pynt at a Glance
    • Who Should Use Pynt?
  • ๐Ÿ‘ฉโ€๐Ÿ’ปAPI Security Testing
    • Security Testing Overview
    • Prerequisites for Running Pynt Scans
    • How to Install Pynt CLI
    • How to install Pynt Binary (Linux only)
    • Pynt CLI Modes
      • ๐Ÿ”ตPynt Command CLI Mode
      • ๐Ÿ”ตPynt Listen CLI Mode
    • Pynt Security Tests Coverage
      • Business Logic Tests
      • Injection Tests
      • Authentication Bypass Tests
      • Mass Assignment Tests
      • Server-Side Request Forgery Tests
      • Stack Trace In Response
      • Lack of Resources and Rate Limiting
      • File Path Manipulation
      • GraphQL Introspection Vulnerability
      • GraphQL Alias Overloading
      • LLM APIs Vulnerabilities
      • Insecure Transport Scheme
      • Basic Authentication
      • HTTP Desynchronization (Desync) Attack
    • Sensitive Data Exposure Detection
    • Pynt Scans Troubleshooting
      • Pynt CLI Troubleshooting
      • Pynt for Postman Troubleshooting
        • Troubleshoot Pynt Container not Running Error
        • Troubleshoot Empty API Key Error
        • Troubleshoot Unauthorized API Key Error
        • Troubleshoot Collection Not Found Error
        • Troubleshoot Non-Unique Collection Name Error
        • Troubleshoot Empty Collection Identifier Error
        • Troubleshoot Unreachable Target Error
        • Troubleshoot Target Responds with Errors Error
        • Troubleshoot Unresolved Target Domain Error
        • Troubleshoot Unresolved Variable Error
        • Troubleshoot TLS Handshake Fail Error
        • Troubleshoot Few Requests Error
        • Troubleshoot One User Only Error
        • Troubleshoot Failed Assertions Error
    • How To
      • How to Run Business Logic Tests with Pynt
      • How to associate a Pynt scan to an Application in Pynt Dashboard
      • How to tag a scan in Pynt
    • Benchmarks
      • Pynt vs OWASP crAPI
  • ๐ŸคฒSecurity Testing Integrations
    • ๐ŸŸ Pynt with API Testing Tools
      • ๐Ÿ”˜Pynt for Postman
        • Fork Pynt Collection
        • Run Pynt Container
        • Run Pynt in Postman
        • View Scan Results in Postman
      • ๐Ÿ”˜Pynt for Insomnia
      • ๐Ÿ”˜Pynt for ReadyAPI
    • ๐ŸŸ Pynt with API Testing CLIs
      • ๐Ÿ”˜Pynt for Newman (Postman CLI)
      • ๐Ÿ”˜Pynt for TestRunner (ReadyAPI CLI)
    • ๐ŸŸ Pynt with Testing Frameworks
      • ๐Ÿ”˜Pynt for .NET (xUnit)
      • ๐Ÿ”˜Pynt for Selenium
      • ๐Ÿ”˜Pynt for Rest Assured
      • ๐Ÿ”˜Pynt for Jest
      • ๐Ÿ”˜Pynt for pytest
      • ๐Ÿ”˜Pynt for Go
      • ๐Ÿ”˜Pynt for JMeter
    • ๐ŸŸ Pynt on CI/CD
      • โ—How to get Pynt ID for CI/CD Authentication
      • ๐Ÿ”˜Pynt for GitHub Actions
      • ๐Ÿ”˜Pynt for Azure DevOps Pipelines
      • ๐Ÿ”˜Pynt for GitLab
      • ๐Ÿ”˜Pynt for Jenkins
    • ๐ŸŸ Pynt with Burp Suite
    • ๐ŸŸ Pynt with Browsers
      • ๐Ÿ”˜Pynt for Firefox Browser
    • ๐ŸŸ Live Traffic Connectors
      • ๐Ÿ”˜eBPF
        • ๐Ÿ”˜Key Components
      • ๐Ÿ”˜Traffic Mirroring
    • ๐ŸŸ Advanced Pynt Examples
      • ๐Ÿ”˜Pynt as a Standalone Container
      • ๐Ÿ”˜Pynt with Prerecorded Har Files
      • ๐Ÿ”˜Pynt with cURL
  • ๐ŸˆธApplications View
    • Application View Overview
    • Manage Applications
      • Add Application
      • Delete Application
      • Rename Application
    • Manage Sources for API Discovery
      • Add Source
      • Delete Source
      • View Source Info
      • Source Categories
        • API Documentation
          • Swagger
          • Postman Collection
        • API Gateways
          • AWS API Gateway
          • Azure API Gateway
          • Kong API Gateway
          • GCP API Gateway
          • Gravitee API Gateway
        • Testing (API Security Scans)
        • Live Traffic
          • Data Collection with eBPF
          • ALB Traffic Capture with AWS Traffic Mirroring
        • Code Repository
    • Application Dashboard
    • Generate Pentest Report
  • ๐Ÿ“šAPI Catalog
    • API Catalog Overview
    • Navigate API Catalog
      • Filtering API Catalog by Application
      • API Catalog Customization
      • API Related Info
      • APIs at Risk
    • Manage API Source Gaps
      • New APIs
      • Untested APIs
      • Shadow APIs
      • Undocumented APIs
    • View Detailed Endpoint Info
  • โชScan History
    • Scan History Overview
    • Navigate Scan History
      • Associating Scans with Specific Application
      • Filtering by Application
      • Scan Related Info
      • Scan History Customization
    • View Detailed Scan Info
    • Associate Vulnerabilities to Tickets with JIRA
  • Account Management
    • Single Sign-On (SSO)
      • Setting up Okta
      • Setting up Entra ID
Powered by GitBook
On this page
  • What is Newman?
  • Pynt's Integration with Newman
  • Setup
  • Run Pynt CLI Command for Newman
  • Basic usage
  • Required arguments
  • Optional arguments
  • Example
  1. Security Testing Integrations
  2. Pynt with API Testing CLIs

Pynt for Newman (Postman CLI)

Run Pynt API security tests on a locally stored postman collection from a terminal

PreviousPynt with API Testing CLIsNextPynt for TestRunner (ReadyAPI CLI)

Last updated 8 months ago

What is Newman?

๐Ÿ’ก is the CLI tool for running Postman collections. It enables you to automate and integrate API tests directly into your CI/CD pipelines.


Pynt's Integration with Newman

Pynt for Newman allows you to integrate advanced API security testing directly into your command-line workflows. By combining the power of Newman with Pynt, you can automate security scans alongside your regular API tests, ensuring that each API run is thoroughly tested for vulnerabilities.

With Pyntโ€™s context-aware security testing capabilities, you can enhance your Postman collections with automated security checks, all executed via Newman. This integration is perfect for teams looking to streamline their security testing within their existing CI/CD processes, providing a seamless way to ensure that your APIs are protected against potential threats.

After each run, Pynt generates detailed reports that highlight any security risks found during testing, giving you the insights needed to address vulnerabilities promptly. By integrating Pynt with Newman, you can maintain the flexibility and efficiency of your command-line testing while significantly boosting your API security.


Setup


Run Pynt CLI Command for Newman

Basic usage

pynt newman --collection <path to collection>

Required arguments

--collection - Postman collection file name

Optional arguments

--environment - Postman environment file name
--reporters output results to json
--host-ca - path to the CA file in PEM format to enable SSL certificate verification for pynt when running through a VPN.
--return-error - 'all-findings' (warnings, or errors), 'errors-only', 'never' (default), 

Example

wget https://raw.githubusercontent.com/pynt-io/pynt/main/goat_functional_tests/goat.postman_collection.json
pynt newman --collection goat.postman_collection.json

As part of its suit, Pynt allows seamless integration with Newman.

First, make sure Pynt's are met.

Follow the instructions to install Pynt container .

๐Ÿ’ก Pynt CLI Troubleshooting: If you're encountering issues with Pynt's CLI, visit the for solutions and troubleshooting tips.

๐Ÿ’ก Still Need Help? For any questions or troubleshooting, reach out to the .

๐Ÿคฒ
๐ŸŸ 
๐Ÿ”˜
API security testing
prerequisites
here
Pynt CLI Troubleshooting Guide
Pynt Community Support
Newman
Newman