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

##### P ath ParametersExpand Collapse account\_id: string Identifier. maxLength32 [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse page: optional number Page number of paginated results. minimum1 [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: optional number Number of results per page. maximum50 minimum5 [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional array of object {id, scan\_type, status, 2 more }

id: string Scan identifier. formatuuid Link to this property scan\_type: "bola" The type of vulnerability scan. Link to this property

status: "created"or "scheduled"or "planning"or 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: string The target environment this scan runs against. formatuuid Link to this property

report: optional object {report, report\_schema\_version } Vulnerability report produced after the scan completes. The shape depends on the scan type. Present only for finished scans.

report: object {summary, tests } Version 1 of the BOLA vulnerability scan report.

summary: object {verdict } Summary of all steps and findings.

verdict: "ok"or "warning"or "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: array of object {steps, verdict, preflight\_errors } List of tests that were run.

steps: array of object {assertions, errors, request, response } Steps that were executed.

assertions: array of object {description, kind, observed, outcome } 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: object {parameters, type } Kind of assertion.

parameters: object {max, min } Range of HTTP status codes.

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

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

Link to this property observed: number Observed value on which the assertion was made. Link to this property

outcome: "ok"or "fail"or "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 array of object {description, error\_code } Errors the step encountered that may explain absent or incomplete fields.

description: string Human-readable error description. Link to this property error\_code: optional number Numeric error code identifying the class of error, if available. formatuint32 minimum0 Link to this property

Link to this property

request: optional object {credential\_set, header\_names, method, 3 more } HTTP request that was made, if any.

credential\_set: object {id, role } Credential set that was used.

id: string ID of the credential set. formatuuid Link to this property

role: "owner"or "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: array of string Names of headers that were sent. Link to this property

method: "GET"or "DELETE"or "PATCH"or 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: string Exact and full URL (including host, query parameters) that was requested. formaturi Link to this property

variable\_captures: array of object {json\_path, name } Variable captures requested for this step.

json\_path: 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: optional unknown Request body, if any. Link to this property

Link to this property

response: optional object {body, header\_names, status, status\_text } HTTP response that was received, if any.

body: object {kind } or object {contents, kind, truncated } or object {contents, kind, truncated } or object {contents, kind, truncated } HTTP response body.

One of the following:

NotFound object {kind } No body was received.

kind: "not\_found" Link to this property

Link to this property

Bytes object {contents, kind, truncated } Body received but unable to read as UTF-8. Raw bytes, base64-encoded.

contents: string Link to this property kind: "bytes" Link to this property truncated: boolean Link to this property

Link to this property

Text object {contents, kind, truncated } Body received as valid UTF-8 text but not valid JSON.

contents: string Link to this property kind: "text" Link to this property truncated: boolean Link to this property

Link to this property

Json object {contents, kind, truncated } Body received as valid JSON.

contents: string Link to this property kind: "json" Link to this property truncated: boolean Link to this property

Link to this property

Link to this property header\_names: array of string Names of headers that were received. Link to this property status: number HTTP status code. maximum65535 minimum0 Link to this property status\_text: optional string HTTP status text, if available for the status code. Link to this property

Link to this property

verdict: "ok"or "warning"or "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 array of object {description, error\_code } Errors that prevented step execution.

Link to this property

Link to this property report\_schema\_version: "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(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)

result\_info: optional object {count, page, per\_page, 2 more }

count: optional number Total number of results for the requested service. Link to this property page: optional number Current page within paginated list of results. Link to this property per\_page: optional number Number of results per page of results. Link to this property total\_count: optional number Total results available without any search parameters. Link to this property total\_pages: optional number The number of total pages in the entire result set. Link to this property

[Link to this property](<#(resource)%20vulnerability_scanner.scans%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) ### List scans HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/vuln_scanner/scans \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } } ```