Skip to main content
GET
/
partner
/
scans
/
completed
Completed scans for instance
curl --request GET \
  --url https://api.example.com/partner/scans/completed
{
  "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>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyrisma.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Response

OK

Represents the JSON structure for retrieving completed scans including data scans, vulnerability scans, and secure baseline scans.

​
header
Completed Scans Header · object

Represents the header information for completed scans including data scans, vulnerability scans, and secure baseline scans.

​
data_scans
Completed Data Scan · object[] | null

List of completed data scans.

​
vulnerability_scans
Completed Vulnerability Scan · object[] | null

List of completed vulnerability scans.

​
secure_baseline_scans
Completed Secure Baseline Scan · object[] | null

List of completed secure baseline scans.