--- title: List scans --- [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** # List scans client.VulnerabilityScanner.Scans.List(ctx, params) (\*V4PagePaginationArray\[[ScanListResponse]()], error) GET/accounts/{account\_id}/vuln\_scanner/scans Returns all scans for the account. ##### 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
params ScanListParams AccountID param.Field\[string] Path param: Identifier. maxLength32 Link to this property Page param.Field\[int64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[int64]Optional Query param: Number of results per page. maximum50 minimum5 Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type ScanListResponse struct{…} ID string Scan identifier. formatuuid Link to this property ScanType ScanListResponseScanType The type of vulnerability scan. Link to this property
Status ScanListResponseStatus Current lifecycle status of the scan. One of the following: const ScanListResponseStatusCreated ScanListResponseStatus = "created" Link to this property const ScanListResponseStatusScheduled ScanListResponseStatus = "scheduled" Link to this property const ScanListResponseStatusPlanning ScanListResponseStatus = "planning" Link to this property const ScanListResponseStatusRunning ScanListResponseStatus = "running" Link to this property const ScanListResponseStatusFinished ScanListResponseStatus = "finished" Link to this property const ScanListResponseStatusFailed ScanListResponseStatus = "failed" Link to this property
Link to this property TargetEnvironmentID string The target environment this scan runs against. formatuuid Link to this property
Report ScanListResponseReportOptional Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.
Report ScanListResponseReportReport Version 1 of the BOLA vulnerability scan report.
Summary ScanListResponseReportReportSummary Summary of all steps and findings.
Verdict ScanListResponseReportReportSummaryVerdict Overall verdict of the vulnerability scan. One of the following: const ScanListResponseReportReportSummaryVerdictOk ScanListResponseReportReportSummaryVerdict = "ok" Link to this property const ScanListResponseReportReportSummaryVerdictWarning ScanListResponseReportReportSummaryVerdict = "warning" Link to this property const ScanListResponseReportReportSummaryVerdictInconclusive ScanListResponseReportReportSummaryVerdict = "inconclusive" Link to this property
Link to this property
Link to this property
Tests \[]ScanListResponseReportReportTest List of tests that were run.
Steps \[]ScanListResponseReportReportTestsStep Steps that were executed.
Assertions \[]ScanListResponseReportReportTestsStepsAssertion 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 ScanListResponseReportReportTestsStepsAssertionsKind Kind of assertion.
Parameters ScanListResponseReportReportTestsStepsAssertionsKindParameters 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 ScanListResponseReportReportTestsStepsAssertionsKindType Link to this property
Link to this property Observed int64 Observed value on which the assertion was made. Link to this property
Outcome ScanListResponseReportReportTestsStepsAssertionsOutcome Outcome of the assertion. One of the following: const ScanListResponseReportReportTestsStepsAssertionsOutcomeOk ScanListResponseReportReportTestsStepsAssertionsOutcome = "ok" Link to this property const ScanListResponseReportReportTestsStepsAssertionsOutcomeFail ScanListResponseReportReportTestsStepsAssertionsOutcome = "fail" Link to this property const ScanListResponseReportReportTestsStepsAssertionsOutcomeInconclusive ScanListResponseReportReportTestsStepsAssertionsOutcome = "inconclusive" Link to this property
Link to this property
Link to this property
Errors \[]ScanListResponseReportReportTestsStepsErrorOptional 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 ScanListResponseReportReportTestsStepsRequestOptional HTTP request that was made, if any.
CredentialSet ScanListResponseReportReportTestsStepsRequestCredentialSet Credential set that was used. ID string ID of the credential set. formatuuid Link to this property
Role ScanListResponseReportReportTestsStepsRequestCredentialSetRole Role of the credential set. One of the following: const ScanListResponseReportReportTestsStepsRequestCredentialSetRoleOwner ScanListResponseReportReportTestsStepsRequestCredentialSetRole = "owner" Link to this property const ScanListResponseReportReportTestsStepsRequestCredentialSetRoleAttacker ScanListResponseReportReportTestsStepsRequestCredentialSetRole = "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 ScanListResponseReportReportTestsStepsRequestMethod HTTP method. One of the following: const ScanListResponseReportReportTestsStepsRequestMethodGet ScanListResponseReportReportTestsStepsRequestMethod = "GET" Link to this property const ScanListResponseReportReportTestsStepsRequestMethodDelete ScanListResponseReportReportTestsStepsRequestMethod = "DELETE" Link to this property const ScanListResponseReportReportTestsStepsRequestMethodPatch ScanListResponseReportReportTestsStepsRequestMethod = "PATCH" Link to this property const ScanListResponseReportReportTestsStepsRequestMethodPost ScanListResponseReportReportTestsStepsRequestMethod = "POST" Link to this property const ScanListResponseReportReportTestsStepsRequestMethodPut ScanListResponseReportReportTestsStepsRequestMethod = "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 \[]ScanListResponseReportReportTestsStepsRequestVariableCapture 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 ScanListResponseReportReportTestsStepsResponseOptional HTTP response that was received, if any.
Body ScanListResponseReportReportTestsStepsResponseBody HTTP response body. One of the following:
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFound struct{…} No body was received. Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseNotFoundKind Link to this property
Link to this property
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytes struct{…} Body received but unable to read as UTF-8. Raw bytes, base64-encoded. Contents string Link to this property Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseBytesKind Link to this property Truncated bool Link to this property
Link to this property
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseText struct{…} Body received as valid UTF-8 text but not valid JSON. Contents string Link to this property Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseTextKind Link to this property Truncated bool Link to this property
Link to this property
type ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJson struct{…} Body received as valid JSON. Contents string Link to this property Kind ScanListResponseReportReportTestsStepsResponseBodyVulnScannerBOLABodyResponseJsonKind 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 ScanListResponseReportReportTestsVerdict Verdict of this single test. One of the following: const ScanListResponseReportReportTestsVerdictOk ScanListResponseReportReportTestsVerdict = "ok" Link to this property const ScanListResponseReportReportTestsVerdictWarning ScanListResponseReportReportTestsVerdict = "warning" Link to this property const ScanListResponseReportReportTestsVerdictInconclusive ScanListResponseReportReportTestsVerdict = "inconclusive" Link to this property
Link to this property
PreflightErrors \[]ScanListResponseReportReportTestsPreflightErrorOptional 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 ScanListResponseReportReportSchemaVersion 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)%20ScanListResponse%20%3E%20(schema)>) ### List scans 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"), ) page, err := client.VulnerabilityScanner.Scans.List(context.TODO(), vulnerability_scanner.ScanListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ##### 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": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```