--- title: Get scan --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Vulnerability Scanner](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner) [Scans](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/scans) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # 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. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### ParametersExpand Collapse account\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) scan\_id: str formatuuid [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20scan_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class ScanGetResponse: …

id: str Scan identifier. formatuuid Link to this property scan\_type: Literal\["bola"] The type of vulnerability scan. Link to this property

status: Literal\["created", "scheduled", "planning", 3 more] Current lifecycle status of the scan.

One of the following: "created" Link to this property "scheduled" Link to this property "planning" Link to this property "running" Link to this property "finished" Link to this property "failed" Link to this property

Link to this property target\_environment\_id: str The target environment this scan runs against. formatuuid Link to this property

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.

One of the following: "ok" Link to this property "warning" Link to this property "inconclusive" Link to this property

Link to this property

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. Link to this property

kind: ReportReportTestStepAssertionKind Kind of assertion.

parameters: ReportReportTestStepAssertionKindParameters Range of HTTP status codes.

max: int Maximum (inclusive) status code of the range. maximum65535 minimum0 Link to this property min: int Minimum (inclusive) status code of the range. maximum65535 minimum0 Link to this property

Link to this property type: Literal\["http\_status\_within\_range"] Link to this property

Link to this property observed: Optional\[int] Observed value on which the assertion was made. Link to this property

outcome: Literal\["ok", "fail", "inconclusive"] Outcome of the assertion.

One of the following: "ok" Link to this property "fail" Link to this property "inconclusive" Link to this property

Link to this property

errors: Optional\[List\[ReportReportTestStepError]] Errors the step encountered that may explain absent or incomplete fields.

description: str Human-readable error description. Link to this property error\_code: Optional\[int] Numeric error code identifying the class of error, if available. formatuint32 minimum0 Link to this property

Link to this property

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. formatuuid Link to this property

role: Literal\["owner", "attacker"] Role of the credential set.

One of the following: "owner" Link to this property "attacker" Link to this property

Link to this property

Link to this property header\_names: List\[str] Names of headers that were sent. Link to this property

method: Literal\["GET", "DELETE", "PATCH", 2 more] HTTP method.

One of the following: "GET" Link to this property "DELETE" Link to this property "PATCH" Link to this property "POST" Link to this property "PUT" Link to this property

Link to this property url: str Exact and full URL (including host, query parameters) that was requested. formaturi Link to this property

variable\_captures: List\[ReportReportTestStepRequestVariableCapture] Variable captures requested for this step.

json\_path: str JSONPath expression used for capture, e.g. "$.id". Link to this property name: str Variable name, e.g. "resource_id". Link to this property

Link to this property body: Optional\[object] Request body, if any. Link to this property

Link to this property

response: Optional\[ReportReportTestStepResponse] HTTP response that was received, if any.

body: ReportReportTestStepResponseBody HTTP response body.

One of the following:

class ReportReportTestStepResponseBodyVulnScannerBOLABodyResponseNotFound: … No body was received.

kind: Literal\["not\_found"] Link to this property

Link to this property

class ReportReportTestStepResponseBodyVulnScannerBOLABodyResponseBytes: … Body received but unable to read as UTF-8. Raw bytes, base64-encoded.

contents: str Link to this property kind: Literal\["bytes"] Link to this property truncated: bool Link to this property

Link to this property

class ReportReportTestStepResponseBodyVulnScannerBOLABodyResponseText: … Body received as valid UTF-8 text but not valid JSON.

contents: str Link to this property kind: Literal\["text"] Link to this property truncated: bool Link to this property

Link to this property

class ReportReportTestStepResponseBodyVulnScannerBOLABodyResponseJson: … Body received as valid JSON.

contents: str Link to this property kind: Literal\["json"] Link to this property truncated: bool Link to this property

Link to this property

Link to this property header\_names: List\[str] Names of headers that were received. Link to this property status: int HTTP status code. maximum65535 minimum0 Link to this property status\_text: Optional\[str] HTTP status text, if available for the status code. Link to this property

Link to this property

verdict: Literal\["ok", "warning", "inconclusive"] Verdict of this single test.

One of the following: "ok" Link to this property "warning" Link to this property "inconclusive" Link to this property

Link to this property

preflight\_errors: Optional\[List\[ReportReportTestPreflightError]] Errors that prevented step execution.

Link to this property

Link to this property report\_schema\_version: Literal\["v1"] Version of the report schema. Link to this property

Link to this property

[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(model)%20scan_get_response%20%3E%20(schema)>) ### Get scan Python HTTPTypeScriptPythonGoTerraform ``` 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) ``` 200 example ``` { "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": {} } ``` ##### Returns Examples 200 example ``` { "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": {} } ```