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>",
      "total_target": 123,
      "total_scan": 123,
      "severity": {
        "info": "<string>",
        "critical": 123,
        "medium": "<string>",
        "low": "<string>",
        "high": "<string>",
        "unknown": "<string>"
      },
      "total_template": 123,
      "updated_at": "<string>",
      "name": "<string>",
      "completed_at": "<string>",
      "is_oss": "<string>",
      "is_cloud": "<string>",
      "scan_frequency": "daily",
      "schedule_last_run": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
offset
string
required

number of scan-status results to skip

​
limit
integer
required

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
​
data
object[]
required
​
message
string

Was this page helpful?

Suggest edits