--- title: Vulnerability Scanner --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Vulnerability Scanner #### Vulnerability ScannerCredential Sets ##### [List credential sets](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/list) vulnerability\_scanner.credential\_sets.list(CredentialSetListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[CredentialSetListResponse]()] GET/accounts/{account\_id}/vuln\_scanner/credential\_sets ##### [Create credential set](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/create) vulnerability\_scanner.credential\_sets.create(CredentialSetCreateParams\*\*kwargs) -> [CredentialSetCreateResponse]() POST/accounts/{account\_id}/vuln\_scanner/credential\_sets ##### [Get credential set](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/get) vulnerability\_scanner.credential\_sets.get(strcredential\_set\_id, CredentialSetGetParams\*\*kwargs) -> [CredentialSetGetResponse]() GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id} ##### [Update credential set](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/update) vulnerability\_scanner.credential\_sets.update(strcredential\_set\_id, CredentialSetUpdateParams\*\*kwargs) -> [CredentialSetUpdateResponse]() PUT/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id} ##### [Edit credential set](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/edit) vulnerability\_scanner.credential\_sets.edit(strcredential\_set\_id, CredentialSetEditParams\*\*kwargs) -> [CredentialSetEditResponse]() PATCH/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id} ##### [Delete credential set](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/methods/delete) vulnerability\_scanner.credential\_sets.delete(strcredential\_set\_id, CredentialSetDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id} ##### ModelsExpand Collapse
class CredentialSetListResponse: … id: str Credential set identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_list_response%20%3E%20(schema)>)
class CredentialSetCreateResponse: … id: str Credential set identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_create_response%20%3E%20(schema)>)
class CredentialSetGetResponse: … id: str Credential set identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_get_response%20%3E%20(schema)>)
class CredentialSetUpdateResponse: … id: str Credential set identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_update_response%20%3E%20(schema)>)
class CredentialSetEditResponse: … id: str Credential set identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_edit_response%20%3E%20(schema)>) #### Vulnerability ScannerCredential SetsCredentials ##### [List credentials](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/list) vulnerability\_scanner.credential\_sets.credentials.list(strcredential\_set\_id, CredentialListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[CredentialListResponse]()] GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials ##### [Create credential](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/create) vulnerability\_scanner.credential\_sets.credentials.create(strcredential\_set\_id, CredentialCreateParams\*\*kwargs) -> [CredentialCreateResponse]() POST/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials ##### [Get credential](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/get) vulnerability\_scanner.credential\_sets.credentials.get(strcredential\_id, CredentialGetParams\*\*kwargs) -> [CredentialGetResponse]() GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id} ##### [Update credential](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/update) vulnerability\_scanner.credential\_sets.credentials.update(strcredential\_id, CredentialUpdateParams\*\*kwargs) -> [CredentialUpdateResponse]() PUT/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id} ##### [Edit credential](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/edit) vulnerability\_scanner.credential\_sets.credentials.edit(strcredential\_id, CredentialEditParams\*\*kwargs) -> [CredentialEditResponse]() PATCH/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id} ##### [Delete credential](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/delete) vulnerability\_scanner.credential\_sets.credentials.delete(strcredential\_id, CredentialDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id} ##### ModelsExpand Collapse
class CredentialListResponse: … A credential attached to API requests during scanning. The credential value is write-only and never returned in responses. id: str Credential identifier. formatuuid Link to this property credential\_set\_id: str Parent credential set identifier. formatuuid Link to this property
location: Literal\["header", "cookie"] Where the credential is attached in outgoing requests. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property location\_name: str Name of the header or cookie where the credential is attached. Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_list_response%20%3E%20(schema)>)
class CredentialCreateResponse: … A credential attached to API requests during scanning. The credential value is write-only and never returned in responses. id: str Credential identifier. formatuuid Link to this property credential\_set\_id: str Parent credential set identifier. formatuuid Link to this property
location: Literal\["header", "cookie"] Where the credential is attached in outgoing requests. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property location\_name: str Name of the header or cookie where the credential is attached. Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_create_response%20%3E%20(schema)>)
class CredentialGetResponse: … A credential attached to API requests during scanning. The credential value is write-only and never returned in responses. id: str Credential identifier. formatuuid Link to this property credential\_set\_id: str Parent credential set identifier. formatuuid Link to this property
location: Literal\["header", "cookie"] Where the credential is attached in outgoing requests. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property location\_name: str Name of the header or cookie where the credential is attached. Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_get_response%20%3E%20(schema)>)
class CredentialUpdateResponse: … A credential attached to API requests during scanning. The credential value is write-only and never returned in responses. id: str Credential identifier. formatuuid Link to this property credential\_set\_id: str Parent credential set identifier. formatuuid Link to this property
location: Literal\["header", "cookie"] Where the credential is attached in outgoing requests. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property location\_name: str Name of the header or cookie where the credential is attached. Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_update_response%20%3E%20(schema)>)
class CredentialEditResponse: … A credential attached to API requests during scanning. The credential value is write-only and never returned in responses. id: str Credential identifier. formatuuid Link to this property credential\_set\_id: str Parent credential set identifier. formatuuid Link to this property
location: Literal\["header", "cookie"] Where the credential is attached in outgoing requests. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property location\_name: str Name of the header or cookie where the credential is attached. Link to this property name: str Human-readable name. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_edit_response%20%3E%20(schema)>) #### Vulnerability ScannerScans ##### [List scans](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/scans/methods/list) vulnerability\_scanner.scans.list(ScanListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[ScanListResponse]()] GET/accounts/{account\_id}/vuln\_scanner/scans ##### [Create scan](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/scans/methods/create) vulnerability\_scanner.scans.create(ScanCreateParams\*\*kwargs) -> [ScanCreateResponse]() POST/accounts/{account\_id}/vuln\_scanner/scans ##### [Get scan](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/scans/methods/get) vulnerability\_scanner.scans.get(strscan\_id, ScanGetParams\*\*kwargs) -> [ScanGetResponse]() GET/accounts/{account\_id}/vuln\_scanner/scans/{scan\_id} ##### ModelsExpand Collapse
class ScanListResponse: … 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
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
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
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. 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
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_list_response%20%3E%20(schema)>)
class ScanCreateResponse: … 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
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
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
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. 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
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_create_response%20%3E%20(schema)>)
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
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
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
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. 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
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)>) #### Vulnerability ScannerTarget Environments ##### [List target environments](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/list) vulnerability\_scanner.target\_environments.list(TargetEnvironmentListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[TargetEnvironmentListResponse]()] GET/accounts/{account\_id}/vuln\_scanner/target\_environments ##### [Create target environment](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/create) vulnerability\_scanner.target\_environments.create(TargetEnvironmentCreateParams\*\*kwargs) -> [TargetEnvironmentCreateResponse]() POST/accounts/{account\_id}/vuln\_scanner/target\_environments ##### [Get target environment](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/get) vulnerability\_scanner.target\_environments.get(strtarget\_environment\_id, TargetEnvironmentGetParams\*\*kwargs) -> [TargetEnvironmentGetResponse]() GET/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id} ##### [Update target environment](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/update) vulnerability\_scanner.target\_environments.update(strtarget\_environment\_id, TargetEnvironmentUpdateParams\*\*kwargs) -> [TargetEnvironmentUpdateResponse]() PUT/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id} ##### [Edit target environment](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/edit) vulnerability\_scanner.target\_environments.edit(strtarget\_environment\_id, TargetEnvironmentEditParams\*\*kwargs) -> [TargetEnvironmentEditResponse]() PATCH/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id} ##### [Delete target environment](https://developers.cloudflare.com/api/python/resources/vulnerability_scanner/subresources/target_environments/methods/delete) vulnerability\_scanner.target\_environments.delete(strtarget\_environment\_id, TargetEnvironmentDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id} ##### ModelsExpand Collapse
class TargetEnvironmentListResponse: … id: str Target environment identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
target: Target Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets. type: Literal\["zone"] Link to this property zone\_tag: str Cloudflare zone tag. The zone must belong to the account. maxLength32 Link to this property
Link to this property description: Optional\[str] Optional description providing additional context. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_list_response%20%3E%20(schema)>)
class TargetEnvironmentCreateResponse: … id: str Target environment identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
target: Target Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets. type: Literal\["zone"] Link to this property zone\_tag: str Cloudflare zone tag. The zone must belong to the account. maxLength32 Link to this property
Link to this property description: Optional\[str] Optional description providing additional context. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_create_response%20%3E%20(schema)>)
class TargetEnvironmentGetResponse: … id: str Target environment identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
target: Target Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets. type: Literal\["zone"] Link to this property zone\_tag: str Cloudflare zone tag. The zone must belong to the account. maxLength32 Link to this property
Link to this property description: Optional\[str] Optional description providing additional context. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_get_response%20%3E%20(schema)>)
class TargetEnvironmentUpdateResponse: … id: str Target environment identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
target: Target Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets. type: Literal\["zone"] Link to this property zone\_tag: str Cloudflare zone tag. The zone must belong to the account. maxLength32 Link to this property
Link to this property description: Optional\[str] Optional description providing additional context. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_update_response%20%3E%20(schema)>)
class TargetEnvironmentEditResponse: … id: str Target environment identifier. formatuuid Link to this property name: str Human-readable name. Link to this property
target: Target Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets. type: Literal\["zone"] Link to this property zone\_tag: str Cloudflare zone tag. The zone must belong to the account. maxLength32 Link to this property
Link to this property description: Optional\[str] Optional description providing additional context. Link to this property
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_edit_response%20%3E%20(schema)>)