Completed scans for instance
curl --request GET \
--url https://api.example.com/partner/scans/completedimport requests
url = "https://api.example.com/partner/scans/completed"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/partner/scans/completed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/partner/scans/completed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/partner/scans/completed"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/partner/scans/completed")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/scans/completed")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"header": {
"data_scan_items": 123,
"data_scan_folders": 123,
"data_scan_sensitive_items": 123,
"average_data_scan_grade": 123,
"average_data_scan_grade_alpha": "<string>",
"times_data_category_scanned": {},
"total_vulnerabilities": 123,
"total_critical_vulnerabilities": 123,
"total_high_vulnerabilities": 123,
"total_medium_vulnerabilities": 123,
"total_low_vulnerabilities": 123,
"average_vulnerability_grade": 123,
"average_vulnerability_grade_alpha": "<string>",
"average_secure_baseline_grade": 123,
"average_secure_baseline_grade_alpha": "<string>"
},
"data_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"scanned_items": 123,
"scanned_folders": 123,
"total_sensitive_items": 123,
"percent_sensitive_items": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"categories": "<string>"
}
],
"vulnerability_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"vulnerabilities": 123,
"critical_vulnerabilities": 123,
"high_vulnerabilities": 123,
"medium_vulnerabilities": 123,
"low_vulnerabilities": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"scan_type_name": "<string>"
}
],
"secure_baseline_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"failed_tests": 123,
"score": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"target_details": "<string>"
}
]
}Scans
Completed scans for instance
Returns completed scans for the instance associated with the access token.
Each completed scan returned by the API includes information such as scan ID, target name, scan status, start and end times, and summary of findings.
Required headers:
Authorization: access_token {token}
GET
/
partner
/
scans
/
completed
Completed scans for instance
curl --request GET \
--url https://api.example.com/partner/scans/completedimport requests
url = "https://api.example.com/partner/scans/completed"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/partner/scans/completed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/partner/scans/completed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/partner/scans/completed"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/partner/scans/completed")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/scans/completed")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"header": {
"data_scan_items": 123,
"data_scan_folders": 123,
"data_scan_sensitive_items": 123,
"average_data_scan_grade": 123,
"average_data_scan_grade_alpha": "<string>",
"times_data_category_scanned": {},
"total_vulnerabilities": 123,
"total_critical_vulnerabilities": 123,
"total_high_vulnerabilities": 123,
"total_medium_vulnerabilities": 123,
"total_low_vulnerabilities": 123,
"average_vulnerability_grade": 123,
"average_vulnerability_grade_alpha": "<string>",
"average_secure_baseline_grade": 123,
"average_secure_baseline_grade_alpha": "<string>"
},
"data_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"scanned_items": 123,
"scanned_folders": 123,
"total_sensitive_items": 123,
"percent_sensitive_items": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"categories": "<string>"
}
],
"vulnerability_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"vulnerabilities": 123,
"critical_vulnerabilities": 123,
"high_vulnerabilities": 123,
"medium_vulnerabilities": 123,
"low_vulnerabilities": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"scan_type_name": "<string>"
}
],
"secure_baseline_scans": [
{
"scan_id": "<string>",
"scan_name": "<string>",
"scan_type": "<string>",
"failed_tests": 123,
"score": 123,
"scan_started": "<string>",
"scan_finished": "<string>",
"grade": 123,
"grade_alpha": "<string>",
"issuing_user": "<string>",
"target_details": "<string>"
}
]
}Headers
Response
OK
Represents the JSON structure for retrieving completed scans including data scans, vulnerability scans, and secure baseline scans.
Represents the header information for completed scans including data scans, vulnerability scans, and secure baseline scans.
Show child attributes
Show child attributes
List of completed data scans.
Show child attributes
Show child attributes
List of completed vulnerability scans.
Show child attributes
Show child attributes
List of completed secure baseline scans.
Show child attributes
Show child attributes
⌘I
