# Scans ## List Scans `vulnerability_scanner.scans.list(ScanListParams**kwargs) -> SyncV4PagePaginationArray[ScanListResponse]` **get** `/accounts/{account_id}/vuln_scanner/scans` Returns all scans for the account. ### Parameters - `account_id: Optional[str]` Identifier. - `page: Optional[int]` Page number of paginated results. - `per_page: Optional[int]` Number of results per page. ### Returns - `class ScanListResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.vulnerability_scanner.scans.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "scan_type": "bola", "status": "created", "target_environment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "report": { "report": { "summary": { "verdict": "ok" }, "tests": [ { "steps": [ { "assertions": [ { "description": "description", "kind": { "parameters": { "max": 0, "min": 0 }, "type": "http_status_within_range" }, "observed": 0, "outcome": "ok" } ], "errors": [ { "description": "description", "error_code": 0 } ], "request": { "credential_set": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "owner" }, "header_names": [ "string" ], "method": "GET", "url": "https://example.com", "variable_captures": [ { "json_path": "json_path", "name": "name" } ], "body": {} }, "response": { "body": { "kind": "not_found" }, "header_names": [ "string" ], "status": 0, "status_text": "status_text" } } ], "verdict": "ok", "preflight_errors": [ { "description": "description", "error_code": 0 } ] } ] }, "report_schema_version": "v1" } } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Create Scan `vulnerability_scanner.scans.create(ScanCreateParams**kwargs) -> ScanCreateResponse` **post** `/accounts/{account_id}/vuln_scanner/scans` Creates and starts a new vulnerability scan. The response may include non-fatal warnings in the `messages` array. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_sets: CredentialSets` Credential set references for a BOLA scan. The scanner uses the `owner` credentials for legitimate requests and the `attacker` credentials to attempt unauthorized access. - `attacker: str` Credential set ID for the attacker. - `owner: str` Credential set ID for the resource owner. - `openapi: str` OpenAPI schema definition for the API under test. The scanner uses this to discover endpoints and construct requests. - `scan_type: Literal["bola"]` - `"bola"` - `target_environment_id: str` The target environment to scan. ### Returns - `class ScanCreateResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) scan = client.vulnerability_scanner.scans.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", credential_sets={ "attacker": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "owner": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", }, openapi="open_api", scan_type="bola", target_environment_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(scan.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "scan_type": "bola", "status": "created", "target_environment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "report": { "report": { "summary": { "verdict": "ok" }, "tests": [ { "steps": [ { "assertions": [ { "description": "description", "kind": { "parameters": { "max": 0, "min": 0 }, "type": "http_status_within_range" }, "observed": 0, "outcome": "ok" } ], "errors": [ { "description": "description", "error_code": 0 } ], "request": { "credential_set": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "owner" }, "header_names": [ "string" ], "method": "GET", "url": "https://example.com", "variable_captures": [ { "json_path": "json_path", "name": "name" } ], "body": {} }, "response": { "body": { "kind": "not_found" }, "header_names": [ "string" ], "status": 0, "status_text": "status_text" } } ], "verdict": "ok", "preflight_errors": [ { "description": "description", "error_code": 0 } ] } ] }, "report_schema_version": "v1" } }, "result_info": {} } ``` ## Get Scan `vulnerability_scanner.scans.get(strscan_id, ScanGetParams**kwargs) -> ScanGetResponse` **get** `/accounts/{account_id}/vuln_scanner/scans/{scan_id}` Returns a single scan by ID. ### Parameters - `account_id: Optional[str]` Identifier. - `scan_id: str` ### Returns - `class ScanGetResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) scan = client.vulnerability_scanner.scans.get( scan_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(scan.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "scan_type": "bola", "status": "created", "target_environment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "report": { "report": { "summary": { "verdict": "ok" }, "tests": [ { "steps": [ { "assertions": [ { "description": "description", "kind": { "parameters": { "max": 0, "min": 0 }, "type": "http_status_within_range" }, "observed": 0, "outcome": "ok" } ], "errors": [ { "description": "description", "error_code": 0 } ], "request": { "credential_set": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "owner" }, "header_names": [ "string" ], "method": "GET", "url": "https://example.com", "variable_captures": [ { "json_path": "json_path", "name": "name" } ], "body": {} }, "response": { "body": { "kind": "not_found" }, "header_names": [ "string" ], "status": 0, "status_text": "status_text" } } ], "verdict": "ok", "preflight_errors": [ { "description": "description", "error_code": 0 } ] } ] }, "report_schema_version": "v1" } }, "result_info": {} } ``` ## Domain Types ### Scan List Response - `class ScanListResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"` ### Scan Create Response - `class ScanCreateResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"` ### Scan Get Response - `class ScanGetResponse: …` - `id: str` Scan identifier. - `scan_type: Literal["bola"]` The type of vulnerability scan. - `"bola"` - `status: Literal["created", "scheduled", "planning", 3 more]` Current lifecycle status of the scan. - `"created"` - `"scheduled"` - `"planning"` - `"running"` - `"finished"` - `"failed"` - `target_environment_id: str` The target environment this scan runs against. - `report: Optional[Report]` Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans. - `report: ReportReport` Version 1 of the BOLA vulnerability scan report. - `summary: ReportReportSummary` Summary of all steps and findings. - `verdict: Literal["ok", "warning", "inconclusive"]` Overall verdict of the vulnerability scan. - `"ok"` - `"warning"` - `"inconclusive"` - `tests: List[ReportReportTest]` List of tests that were run. - `steps: List[ReportReportTestStep]` Steps that were executed. - `assertions: List[ReportReportTestStepAssertion]` Assertions that were made against the received response. - `description: str` Human-readable description of the assertion, explaining what was checked. - `kind: ReportReportTestStepAssertionKind` Kind of assertion. - `parameters: ReportReportTestStepAssertionKindParameters` Range of HTTP status codes. - `max: int` Maximum (inclusive) status code of the range. - `min: int` Minimum (inclusive) status code of the range. - `type: Literal["http_status_within_range"]` - `"http_status_within_range"` - `observed: Optional[int]` Observed value on which the assertion was made. - `outcome: Literal["ok", "fail", "inconclusive"]` Outcome of the assertion. - `"ok"` - `"fail"` - `"inconclusive"` - `errors: Optional[List[ReportReportTestStepError]]` Errors the step encountered that may explain absent or incomplete fields. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `request: Optional[ReportReportTestStepRequest]` HTTP request that was made, if any. - `credential_set: ReportReportTestStepRequestCredentialSet` Credential set that was used. - `id: str` ID of the credential set. - `role: Literal["owner", "attacker"]` Role of the credential set. - `"owner"` - `"attacker"` - `header_names: List[str]` Names of headers that were sent. - `method: Literal["GET", "DELETE", "PATCH", 2 more]` HTTP method. - `"GET"` - `"DELETE"` - `"PATCH"` - `"POST"` - `"PUT"` - `url: str` Exact and full URL (including host, query parameters) that was requested. - `variable_captures: List[ReportReportTestStepRequestVariableCapture]` Variable captures requested for this step. - `json_path: str` JSONPath expression used for capture, e.g. `"$.id"`. - `name: str` Variable name, e.g. `"resource_id"`. - `body: Optional[object]` Request body, if any. - `response: Optional[ReportReportTestStepResponse]` HTTP response that was received, if any. - `body: ReportReportTestStepResponseBody` HTTP response body. - `class ReportReportTestStepResponseBodyKind: …` No body was received. - `kind: Literal["not_found"]` - `"not_found"` - `class ReportReportTestStepResponseBodyUnionMember1: …` Body received but unable to read as UTF-8. Raw bytes, base64-encoded. - `contents: str` - `kind: Literal["bytes"]` - `"bytes"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember2: …` Body received as valid UTF-8 text but not valid JSON. - `contents: str` - `kind: Literal["text"]` - `"text"` - `truncated: bool` - `class ReportReportTestStepResponseBodyUnionMember3: …` Body received as valid JSON. - `contents: str` - `kind: Literal["json"]` - `"json"` - `truncated: bool` - `header_names: List[str]` Names of headers that were received. - `status: int` HTTP status code. - `status_text: Optional[str]` HTTP status text, if available for the status code. - `verdict: Literal["ok", "warning", "inconclusive"]` Verdict of this single test. - `"ok"` - `"warning"` - `"inconclusive"` - `preflight_errors: Optional[List[ReportReportTestPreflightError]]` Errors that prevented step execution. - `description: str` Human-readable error description. - `error_code: Optional[int]` Numeric error code identifying the class of error, if available. - `report_schema_version: Literal["v1"]` Version of the report schema. - `"v1"`