How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ProjectDiscovery scans API

The scans API from ProjectDiscovery — 17 operation(s) for scans.

ProjectDiscovery scans API is one of 20 APIs that ProjectDiscovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scans. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 26 operations across 17 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.projectdiscovery.io, https://api.dev.projectdiscovery.io, http://localhost:8085.

26 operations 17 paths 20 schemas 4 DELETE10 GET5 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.projectdiscovery.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ProjectDiscovery scans API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (X-API-Key). By default, every request must be authenticated.

Paths & Operations 26

Across 17 paths, the API surfaces 26 operations — 4 DELETE, 10 GET, 5 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

scans 26
GET
/v1/scans
Get Scan List
get-v1-scans 8 params → 200400401499500default
POST
/v1/scans
Create Scan
post-v1-scans 1 param body → 200400401500default
DELETE
/v1/scans
Delete Scan in bulk
delete-v1-scans 1 param body → 200400401500default
GET
/v1/scans/{scan_id}
Get Scan
get-v1-scans-scan_id 2 params → 200400401404499500default
DELETE
/v1/scans/{scan_id}
Delete Scan
delete-v1-scans-scan_id 2 params → 200400401500default
PATCH
/v1/scans/{scan_id}
Update Scan
patch-v1-scans-scan_id 2 params body → 200400401500default
POST
/v1/scans/import
Import OSS Scan
post-v1-scans-import 2 params body → 200400401500default
POST
/v1/scans/{scan_id}/stop
Stop Scan
post-v1-scans-scan_id-stop 2 params → 200400401500default
POST
/v1/scans/{scan_id}/rescan
Rescan scan
post-v1-scans-scan_id-rescan 2 params → 200400401500default
POST
/v1/scans/{vuln_id}/retest
Retest vulnerability
post-v1-scans-vuln_id-retest 2 params body → 200400401500default
GET
/v1/scans/schedule
Get Scan Schedules
get-v1-scans-schedule 1 param → 200400401500default
POST
/v1/scans/schedule
Set Scan Schedule
post-v1-scans-schedule 1 param body → 200400401500default
DELETE
/v1/scans/schedule
Delete Scan Schedule
delete-v1-scans-schedule 2 params → 200400401500default
GET
/v1/scans/scan_ips
Get Scan IPs
get-v1-scans-scan_ips 1 param → 200400401403500default
PATCH
/v1/scans/{scan_id}/import
Update Imported Scan
patch-v1-scans-scan_id-import 2 params body → 200401403500default
GET
/v1/scans/{scan_id}/export
Export Scan
get-v1-scans-scan_id-export 4 params → 200201401403500default
POST
/v1/scans/{scan_id}/export
Export Filtered Scan
post-v1-scans-scan_id-export 4 params body → 200201401403500default
GET
/v1/scans/vuln/{vuln_id}/export
Export Scan Vulnerability
get-v1-scans-vuln-vuln_id-export 3 params → 200401403500default
PATCH
/v1/scans/vulns
Update Vulnerability Status
patch-v1-scans-vulns 1 param body → 200400401500default
DELETE
/v1/scans/vulns
Delete Scan Vulnerability
delete-v1-scans-vulns 1 param body → 200400401500default
PATCH
/v1/scans/vulns/labels
Update Vulnerability Labels
patch-v1-scans-vulns-labels 1 param body → 200400401500default
GET
/v1/scans/{scan_id}/config
Get Scan Config
get-scans-id-config 2 params → 200400401500default
PATCH
/v1/scans/{scan_id}/config
Update Scan Config
patch-scans-id-config 3 params body → 200400401500default
GET
/v1/scans/history
Get All Scans History
get-v1-scans-history 6 params → 200400401500default
GET
/v1/scans/{scanId}/history
Get Scan History
get-v1-scans-scanId-history 7 params → 200400401500default
GET
/v1/scans/{scan_id}/asset/export
Export list of unique assets for a scan
get-v1-scans-scan-id-assets-export 3 params → 200400401404500default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are EnumerationContent (47 properties), ScanStatusItem (31 properties), AssetFilters (23 properties), VulnerabilityResultsOld (20 properties). Each schema is shown below with its type and property counts.

EnumerationIDTypes
object
1 property 1 required
ScanStatusItem
object
31 properties 15 required
ScanConfigItem
object
4 properties 3 required
TimeRangeQueryParameter
string
VulnerabilityEvent
object
20 properties
ScanConfig
object
17 properties
EnumerationIDTypesDetail
object
6 properties 4 required
VulnIssueTrackerItem
object
2 properties
VulnStatusEnum
VulnerabilityResultsOld
object
20 properties 7 required
EnumerationSourceValue
object
2 properties 2 required
EnumerationContentTechnologyDetails
object
4 properties
ScanSchedule
object
7 properties 4 required
ScanConfigUpdateItem
object
15 properties
PrivateTemplates
object
2 properties 2 required
SchedulerFrequency
string
Allowed frequencies for the scheduler
ScansHistoryItems
object
12 properties
EnumerationIds
object
1 property 1 required
AssetFilters
object
23 properties
EnumerationContent
object
47 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

projectdiscovery-scans-api-openapi.yml Raw ↑

Other APIs ProjectDiscovery publishes across the network.

ProjectDiscovery Asset API
ProjectDiscovery assets API
ProjectDiscovery chaos API
ProjectDiscovery configurations API
ProjectDiscovery enumerations API
ProjectDiscovery export API
ProjectDiscovery history API
ProjectDiscovery internal API
ProjectDiscovery Leaks API
ProjectDiscovery results API
ProjectDiscovery retests API
ProjectDiscovery scan_log API
Where this information came from

This is an independent, third-party profile of ProjectDiscovery scans API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.