Developer API
The Detectify REST API provides programmatic access to your security data, allowing you to integrate Detectify into your workflows, automate scanning, and extract vulnerability and asset information.
API Reference
Full interactive API documentation with endpoint specifications, request/response schemas, and examples is available at:
API Versions
Detectify provides two API versions:
| Version | Purpose | Base path | Reference |
|---|---|---|---|
| API v2 | Scanning, vulnerabilities, assets, scan profiles, DNS zones, and teams | /rest/v2/ | View docs |
| API v3 | Attack surface data: IP addresses, technologies, ports, breaches, and connectors | /rest/v3/ | View docs |
Both versions are active and supported. Use v2 for managing scans and retrieving vulnerability data. Use v3 for querying attack surface discovery data.
Quick Start
All API requests are made to https://api.detectify.com and require an API key. See Authentication for setup instructions.
curl -H "X-Detectify-Key: YOUR_API_KEY" \
https://api.detectify.com/rest/v2/assets/Common Use Cases
| Use case | API version | Key endpoints |
|---|---|---|
| Trigger scans from CI/CD | v2 | Scanning, Scan Profiles |
| Export vulnerability reports | v2 | Vulnerabilities |
| Monitor attack surface changes | v3 | IP Addresses, Technologies, Ports |
| Manage assets programmatically | v2 | Assets |
| Sync cloud infrastructure | v3 | Connectors |
For endpoint details, parameters, and response schemas, see the full API reference .
Last updated on