curl --request GET \
--url https://api.projectdiscovery.io/v1/scans/{scan_id} \
--header 'X-API-Key: <api-key>'
{
"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
]
},
"total_result": 123
}
Get details of a scan by scan ID
curl --request GET \
--url https://api.projectdiscovery.io/v1/scans/{scan_id} \
--header 'X-API-Key: <api-key>'
{
"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
]
},
"total_result": 123
}
Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team
Example response
The response is of type object
.
Was this page helpful?