Quickstart
Get NAT running and scanning your first API in under five minutes.
Want to explore NAT without connecting a real API? Run nat demo after installation for a fully sandboxed walkthrough.
Prerequisites
- Python 3.9 or later
- An API to test (REST or GraphQL), or use demo mode
Installation and first scan
Install NAT
pip install nat-engineVerify the installation:
nat --versionAuthenticate (SaaS plan) or skip (self-hosted)
If you are using the hosted SaaS plan, log in with your API key:
nat auth login --key YOUR_API_KEYSelf-hosted users can skip this step — see Self-Hosted Setup for configuration details.
Run your first scan
Point NAT at your API's base URL:
nat scan --url https://api.example.comNAT will auto-discover endpoints and begin testing. Results stream to your terminal in real time.
View the report
When the scan completes, open the HTML report:
nat report --openOr log in to the dashboard at app.nat-testing.io (opens in a new tab) to see results with full risk scoring and remediation guidance.
Try demo mode
Demo mode runs a complete scan against a built-in example API — no credentials, no external dependencies:
nat demoSee the Demo Mode guide for a detailed walkthrough.
Next steps
- Installation guide — detailed install options including Docker
- Your First Scan — in-depth walkthrough of a real scan
- CLI Reference — full command reference
- CI/CD Integration — add NAT to your pipeline