GET
/
v1
/
scans
curl --request GET \
  --url https://api.projectdiscovery.io/v1/scans \
  --header 'X-API-Key: <api-key>'
{
  "current_page": 123,
  "result_count": 123,
  "total_results": 123,
  "total_pages": 123,
  "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,
      "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>"
      ],
      "schedule": {
        "scan_frequency": "<string>",
        "scan_id": "<string>",
        "schedule_last_run": "<string>",
        "schedule_next_run": "<string>",
        "start_time": "<string>",
        "hourly_frequency": 123,
        "custom_weekdays": [
          3
        ]
      }
    }
  ]
}

Authorizations

X-API-Key
string
headerrequired

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, scheduled)

sort_asc
string

comma separated ascending sorting e.g sort_asc=created_at,severity

sort_desc
string

comma separated descending sorting e.g sort_desc=created_at,severity

Response

200 - application/json
current_page
integer
required
result_count
integer
required
total_results
integer
required
total_pages
integer
required
message
string
required
data
object[]
required

Was this page helpful?

Get Shared TemplateCreate Scan