Get Scan

Get details of a scan by scan ID

GET /v1/scans/{scan_id}

Get Scan

cURL

curl --request GET \
  --url https://api.projectdiscovery.io/v1/scans/{scan_id} \
  --header 'X-API-Key: <api-key>'

200

{
  "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>",
  "is_oss": true,
  "is_cloud": true,
  "total_result": 123,
  "severity": {},
  "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
    ]
  },
  "is_automatic": true,
  "agent_id": "<string>",
  "agent_tags": [
    "<string>"
  ],
  "agent_networks": [
    "<string>"
  ],
  "agent_behavior": "distribute",
  "is_internal": true
}

Authorizations

X-API-Key · string · header · required

Headers

X-Team-Id · string

Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team

Path Parameters

scan_id · string · required

Response

200

application/json

Example response

scan_id · string · required

status · string · required

scan_time_elapsed · string · required

progress · integer · required

failure_reason · string · required

created_at · string · required

updated_at · string · required

total_target · integer · required

completed_at · string · required

total_scan · integer · required

total_template · integer · required

name · string · required

is_oss · boolean · required

is_cloud · boolean · required

total_result · integer · required

severity · object

asset_ids · string[]

is_rescan · boolean

public_templates · string[]

report_config_ids · string[]

rescan_count · integer

scan_config_ids · string[]

template_ids · string[]

template_urls · string[]

schedule · ScanSchedule · object

Show child attributes

is_automatic · boolean

agent_id · string

agent_tags · string[]

agent_networks · string[]

agent_behavior · enum<string> · default: distribute

Available options: distribute, mirror

is_internal · boolean