GET
/
v1
/
scans
curl --request GET \
  --url https://api.projectdiscovery.io/v1/scans \
  --header 'X-API-Key: <api-key>'
{
  "message": "<string>",
  "data": [
    {
      "scan_id": "<string>",
      "status": "<string>",
      "scan_time_elapsed": "<string>",
      "progress": 123,
      "failure_reason": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "total_target": 123,
      "completed_at": "<string>",
      "total_scan": 123,
      "total_template": 123,
      "name": "<string>",
      "severity": {},
      "is_oss": true,
      "is_cloud": true,
      "scan_frequency": "<string>",
      "schedule_last_run": "<string>",
      "asset_ids": [
        "<string>"
      ],
      "is_rescan": true,
      "public_templates": [
        "<string>"
      ],
      "report_config_ids": [
        "<string>"
      ],
      "rescan_count": 123,
      "scan_config_ids": [
        "<string>"
      ],
      "template_ids": [
        "<string>"
      ],
      "template_urls": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
offset
integer

number of scan-status results to skip

​
limit
integer

number of scan-status results to fetch

​
search
string

search term for running scans

​
status
string

filter by status (failed, finished, queued, running, starting, uploaded)

Response

200
application/json
Example response
​
message
string
required
​
data
object[]
required

Was this page helpful?

Suggest edits
Get Shared TemplateCreate Scan