--- title: Get scan --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Vulnerability Scanner](https://developers.cloudflare.com/api/go/resources/vulnerability_scanner) [Scans](https://developers.cloudflare.com/api/go/resources/vulnerability_scanner/subresources/scans) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get scan client.VulnerabilityScanner.Scans.Get(ctx, scanID, query) (\*[ScanGetResponse](), error) 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 scanID string 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)>)
query ScanGetParams AccountID param.Field\[string] Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type ScanGetResponse struct{…} ID string Scan identifier. formatuuid Link to this property ScanType ScanGetResponseScanType The type of vulnerability scan. Link to this property
Status ScanGetResponseStatus Current lifecycle status of the scan. One of the following: const ScanGetResponseStatusCreated ScanGetResponseStatus = "created" Link to this property const ScanGetResponseStatusScheduled ScanGetResponseStatus = "scheduled" Link to this property const ScanGetResponseStatusPlanning ScanGetResponseStatus = "planning" Link to this property const ScanGetResponseStatusRunning ScanGetResponseStatus = "running" Link to this property const ScanGetResponseStatusFinished ScanGetResponseStatus = "finished" Link to this property const ScanGetResponseStatusFailed ScanGetResponseStatus = "failed" Link to this property
Link to this property TargetEnvironmentID string The target environment this scan runs against. formatuuid Link to this property
Report ScanGetResponseReportOptional Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.
Report ScanGetResponseReportReport Version 1 of the BOLA vulnerability scan report.
Summary ScanGetResponseReportReportSummary Summary of all steps and findings.
Verdict ScanGetResponseReportReportSummaryVerdict Overall verdict of the vulnerability scan. One of the following: const ScanGetResponseReportReportSummaryVerdictOk ScanGetResponseReportReportSummaryVerdict = "ok" Link to this property const ScanGetResponseReportReportSummaryVerdictWarning ScanGetResponseReportReportSummaryVerdict = "warning" Link to this property const ScanGetResponseReportReportSummaryVerdictInconclusive ScanGetResponseReportReportSummaryVerdict = "inconclusive" Link to this property
Link to this property
Link to this property
Tests \[]ScanGetResponseReportReportTest List of tests that were run.
Steps \[]ScanGetResponseReportReportTestsStep Steps that were executed.
Assertions \[]ScanGetResponseReportReportTestsStepsAssertion Assertions that were made against the received response. Description string Human-readable description of the assertion, explaining what was checked. Link to this property
Kind ScanGetResponseReportReportTestsStepsAssertionsKind Kind of assertion.
Parameters ScanGetResponseReportReportTestsStepsAssertionsKindParameters Range of HTTP status codes. Max int64 Maximum (inclusive) status code of the range. maximum65535 minimum0 Link to this property Min int64 Minimum (inclusive) status code of the range. maximum65535 minimum0 Link to this property
Link to this property Type ScanGetResponseReportReportTestsStepsAssertionsKindType Link to this property
Link to this property Observed int64 Observed value on which the assertion was made. Link to this property
Outcome ScanGetResponseReportReportTestsStepsAssertionsOutcome Outcome of the assertion. One of the following: const ScanGetResponseReportReportTestsStepsAssertionsOutcomeOk ScanGetResponseReportReportTestsStepsAssertionsOutcome = "ok" Link to this property const ScanGetResponseReportReportTestsStepsAssertionsOutcomeFail ScanGetResponseReportReportTestsStepsAssertionsOutcome = "fail" Link to this property const ScanGetResponseReportReportTestsStepsAssertionsOutcomeInconclusive ScanGetResponseReportReportTestsStepsAssertionsOutcome = "inconclusive" Link to this property
Link to this property
Link to this property
Errors \[]ScanGetResponseReportReportTestsStepsErrorOptional Errors the step encountered that may explain absent or incomplete fields. Description string Human-readable error description. Link to this property ErrorCode int64Optional Numeric error code identifying the class of error, if available. formatuint32 minimum0 Link to this property
Link to this property
Request ScanGetResponseReportReportTestsStepsRequestOptional HTTP request that was made, if any.
CredentialSet ScanGetResponseReportReportTestsStepsRequestCredentialSet Credential set that was used. ID string ID of the credential set. formatuuid Link to this property
Role ScanGetResponseReportReportTestsStepsRequestCredentialSetRole Role of the credential set. One of the following: const ScanGetResponseReportReportTestsStepsRequestCredentialSetRoleOwner ScanGetResponseReportReportTestsStepsRequestCredentialSetRole = "owner" Link to this property const ScanGetResponseReportReportTestsStepsRequestCredentialSetRoleAttacker ScanGetResponseReportReportTestsStepsRequestCredentialSetRole = "attacker" Link to this property
Link to this property
Link to this property HeaderNames \[]string Names of headers that were sent. Link to this property
Method ScanGetResponseReportReportTestsStepsRequestMethod HTTP method. One of the following: const ScanGetResponseReportReportTestsStepsRequestMethodGet ScanGetResponseReportReportTestsStepsRequestMethod = "GET" Link to this property const ScanGetResponseReportReportTestsStepsRequestMethodDelete ScanGetResponseReportReportTestsStepsRequestMethod = "DELETE" Link to this property const ScanGetResponseReportReportTestsStepsRequestMethodPatch ScanGetResponseReportReportTestsStepsRequestMethod = "PATCH" Link to this property const ScanGetResponseReportReportTestsStepsRequestMethodPost ScanGetResponseReportReportTestsStepsRequestMethod = "POST" Link to this property const ScanGetResponseReportReportTestsStepsRequestMethodPut ScanGetResponseReportReportTestsStepsRequestMethod = "PUT" Link to this property
Link to this property URL string Exact and full URL (including host, query parameters) that was requested. formaturi Link to this property
VariableCaptures \[]ScanGetResponseReportReportTestsStepsRequestVariableCapture Variable captures requested for this step. JsonPath string JSONPath expression used for capture, e.g. "$.id". Link to this property Name string Variable name, e.g. "resource_id". Link to this property
Link to this property Body unknownOptional Request body, if any. Link to this property
Link to this property
Response ScanGetResponseReportReportTestsStepsResponseOptional HTTP response that was received, if any.
Body ScanGetResponseReportReportTestsStepsResponseBody HTTP response body. One of the following:
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound struct{…} No body was received. Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind Link to this property
Link to this property
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes struct{…} Body received but unable to read as UTF-8. Raw bytes, base64-encoded. Contents string Link to this property Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind Link to this property Truncated bool Link to this property
Link to this property
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText struct{…} Body received as valid UTF-8 text but not valid JSON. Contents string Link to this property Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind Link to this property Truncated bool Link to this property
Link to this property
type ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson struct{…} Body received as valid JSON. Contents string Link to this property Kind ScanGetResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind Link to this property Truncated bool Link to this property
Link to this property
Link to this property HeaderNames \[]string Names of headers that were received. Link to this property Status int64 HTTP status code. maximum65535 minimum0 Link to this property StatusText stringOptional HTTP status text, if available for the status code. Link to this property
Link to this property
Link to this property
Verdict ScanGetResponseReportReportTestsVerdict Verdict of this single test. One of the following: const ScanGetResponseReportReportTestsVerdictOk ScanGetResponseReportReportTestsVerdict = "ok" Link to this property const ScanGetResponseReportReportTestsVerdictWarning ScanGetResponseReportReportTestsVerdict = "warning" Link to this property const ScanGetResponseReportReportTestsVerdictInconclusive ScanGetResponseReportReportTestsVerdict = "inconclusive" Link to this property
Link to this property
PreflightErrors \[]ScanGetResponseReportReportTestsPreflightErrorOptional Errors that prevented step execution. Description string Human-readable error description. Link to this property ErrorCode int64Optional Numeric error code identifying the class of error, if available. formatuint32 minimum0 Link to this property
Link to this property
Link to this property
Link to this property ReportSchemaVersion ScanGetResponseReportReportSchemaVersion 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)%20ScanGetResponse%20%3E%20(schema)>) ### Get scan Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/vulnerability_scanner" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) scan, err := client.VulnerabilityScanner.Scans.Get( context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", vulnerability_scanner.ScanGetParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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": {} } ```