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
  • Introduction
  • Install Pynt CLI
  • Running Pynt for the First Time
  • Do I Need to Pull the Pynt Docker Image?
  1. API Security Testing

How to Install Pynt CLI

Learn how to install the Pynt container for seamless API security testing. Follow our quick guide to set up and deploy Pynt in your environment.

PreviousPrerequisites for Running Pynt ScansNextHow to install Pynt Binary (Linux only)

Last updated 8 months ago

At a Glance: πŸš€ Learn how to install the Pynt container for seamless API security testing in a few simple steps. This guide covers everything from setting up Pynt CLI to running your first Pynt scan.

Introduction

Installing the Pynt container is a straightforward process, enabling you to set up and deploy comprehensive API security testing in your environment. Whether you're integrating Pynt into CI/CD pipelines or running it standalone, follow these steps to get Pynt up and running smoothly.

πŸ’‘ Why Pynt's Container is Needed: Pynt's container allows you to run Pynt from any location, supporting deployment in local or on-premises. It ensures Pynt is available for API security testing in flexible setups. However, for Postman, there’s an option to run Pynt directly from the SaaS platform, eliminating the need to install a container. If you prefer this option, you may skip this section.


Install Pynt CLI

Pynt is deployed as a Python-based CLI. To install the Pynt CLI, simply use pip:

python3 -m pip install pyntcli

πŸ“₯ Tip: Ensure Python 3 is installed before running the above command!


Running Pynt for the First Time

On the first time running Pynt CLI you will need to authenticate with Pynt:

Once authenticated, the CLI will not ask for authentication again. You won’t need to log in again unless your session expires.


Do I Need to Pull the Pynt Docker Image?

No. Pynt will handle anything for you!

πŸ› οΈ No manual docker operations are needed! The Pynt CLI automatically manages all Docker operations, including pulling the latest image and running the container.

πŸ‘©β€πŸ’»
First login with Pynt CLI