---
title: Vulnerability Scanner
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
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/resources/vulnerability_scanner/subresources/credential_sets/methods/list)
GET/accounts/{account\_id}/vuln\_scanner/credential\_sets
##### [Create credential set](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/methods/create)
POST/accounts/{account\_id}/vuln\_scanner/credential\_sets
##### [Get credential set](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/methods/get)
GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}
##### [Update credential set](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/methods/update)
PUT/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}
##### [Edit credential set](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/methods/edit)
PATCH/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}
##### [Delete credential set](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/methods/delete)
DELETE/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}
##### ModelsExpand Collapse
CredentialSetListResponse object {id, name }
id: string
Credential set identifier.
formatuuid
Link to this property
name: string
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)>)
CredentialSetCreateResponse object {id, name }
id: string
Credential set identifier.
formatuuid
Link to this property
name: string
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)>)
CredentialSetGetResponse object {id, name }
id: string
Credential set identifier.
formatuuid
Link to this property
name: string
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)>)
CredentialSetUpdateResponse object {id, name }
id: string
Credential set identifier.
formatuuid
Link to this property
name: string
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)>)
CredentialSetEditResponse object {id, name }
id: string
Credential set identifier.
formatuuid
Link to this property
name: string
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)>)
CredentialSetDeleteResponse = unknown
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets%20%3E%20(model)%20credential_set_delete_response%20%3E%20(schema)>)
#### Vulnerability ScannerCredential SetsCredentials
##### [List credentials](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/list)
GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials
##### [Create credential](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/create)
POST/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials
##### [Get credential](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/get)
GET/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id}
##### [Update credential](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/update)
PUT/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id}
##### [Edit credential](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/edit)
PATCH/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id}
##### [Delete credential](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/credential_sets/subresources/credentials/methods/delete)
DELETE/accounts/{account\_id}/vuln\_scanner/credential\_sets/{credential\_set\_id}/credentials/{credential\_id}
##### ModelsExpand Collapse
CredentialListResponse object {id, credential\_set\_id, location, 2 more }
A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.
id: string
Credential identifier.
formatuuid
Link to this property
credential\_set\_id: string
Parent credential set identifier.
formatuuid
Link to this property
location: "header"or "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: string
Name of the header or cookie where the credential is attached.
Link to this property
name: string
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)>)
CredentialCreateResponse object {id, credential\_set\_id, location, 2 more }
A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.
id: string
Credential identifier.
formatuuid
Link to this property
credential\_set\_id: string
Parent credential set identifier.
formatuuid
Link to this property
location: "header"or "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: string
Name of the header or cookie where the credential is attached.
Link to this property
name: string
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)>)
CredentialGetResponse object {id, credential\_set\_id, location, 2 more }
A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.
id: string
Credential identifier.
formatuuid
Link to this property
credential\_set\_id: string
Parent credential set identifier.
formatuuid
Link to this property
location: "header"or "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: string
Name of the header or cookie where the credential is attached.
Link to this property
name: string
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)>)
CredentialUpdateResponse object {id, credential\_set\_id, location, 2 more }
A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.
id: string
Credential identifier.
formatuuid
Link to this property
credential\_set\_id: string
Parent credential set identifier.
formatuuid
Link to this property
location: "header"or "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: string
Name of the header or cookie where the credential is attached.
Link to this property
name: string
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)>)
CredentialEditResponse object {id, credential\_set\_id, location, 2 more }
A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.
id: string
Credential identifier.
formatuuid
Link to this property
credential\_set\_id: string
Parent credential set identifier.
formatuuid
Link to this property
location: "header"or "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: string
Name of the header or cookie where the credential is attached.
Link to this property
name: string
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)>)
CredentialDeleteResponse = unknown
[Link to this property](<#(resource)%20vulnerability_scanner.credential_sets.credentials%20%3E%20(model)%20credential_delete_response%20%3E%20(schema)>)
#### Vulnerability ScannerScans
##### [List scans](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/scans/methods/list)
GET/accounts/{account\_id}/vuln\_scanner/scans
##### [Create scan](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/scans/methods/create)
POST/accounts/{account\_id}/vuln\_scanner/scans
##### [Get scan](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/scans/methods/get)
GET/accounts/{account\_id}/vuln\_scanner/scans/{scan\_id}
##### ModelsExpand Collapse
ScanListResponse 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
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
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
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.
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
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(model)%20scan_list_response%20%3E%20(schema)>)
ScanCreateResponse 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
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
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
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.
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
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(model)%20scan_create_response%20%3E%20(schema)>)
ScanGetResponse 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
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
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
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.
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
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(model)%20scan_get_response%20%3E%20(schema)>)
#### Vulnerability ScannerTarget Environments
##### [List target environments](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/list)
GET/accounts/{account\_id}/vuln\_scanner/target\_environments
##### [Create target environment](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/create)
POST/accounts/{account\_id}/vuln\_scanner/target\_environments
##### [Get target environment](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/get)
GET/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id}
##### [Update target environment](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/update)
PUT/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id}
##### [Edit target environment](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/edit)
PATCH/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id}
##### [Delete target environment](https://developers.cloudflare.com/api/resources/vulnerability_scanner/subresources/target_environments/methods/delete)
DELETE/accounts/{account\_id}/vuln\_scanner/target\_environments/{target\_environment\_id}
##### ModelsExpand Collapse
TargetEnvironmentListResponse object {id, name, target, description }
id: string
Target environment identifier.
formatuuid
Link to this property
name: string
Human-readable name.
Link to this property
target: object {type, zone\_tag }
Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.
type: "zone"
Link to this property
zone\_tag: string
Cloudflare zone tag. The zone must belong to the account.
maxLength32
Link to this property
Link to this property
description: optional string
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)>)
TargetEnvironmentCreateResponse object {id, name, target, description }
id: string
Target environment identifier.
formatuuid
Link to this property
name: string
Human-readable name.
Link to this property
target: object {type, zone\_tag }
Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.
type: "zone"
Link to this property
zone\_tag: string
Cloudflare zone tag. The zone must belong to the account.
maxLength32
Link to this property
Link to this property
description: optional string
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)>)
TargetEnvironmentGetResponse object {id, name, target, description }
id: string
Target environment identifier.
formatuuid
Link to this property
name: string
Human-readable name.
Link to this property
target: object {type, zone\_tag }
Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.
type: "zone"
Link to this property
zone\_tag: string
Cloudflare zone tag. The zone must belong to the account.
maxLength32
Link to this property
Link to this property
description: optional string
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)>)
TargetEnvironmentUpdateResponse object {id, name, target, description }
id: string
Target environment identifier.
formatuuid
Link to this property
name: string
Human-readable name.
Link to this property
target: object {type, zone\_tag }
Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.
type: "zone"
Link to this property
zone\_tag: string
Cloudflare zone tag. The zone must belong to the account.
maxLength32
Link to this property
Link to this property
description: optional string
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)>)
TargetEnvironmentEditResponse object {id, name, target, description }
id: string
Target environment identifier.
formatuuid
Link to this property
name: string
Human-readable name.
Link to this property
target: object {type, zone\_tag }
Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.
type: "zone"
Link to this property
zone\_tag: string
Cloudflare zone tag. The zone must belong to the account.
maxLength32
Link to this property
Link to this property
description: optional string
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)>)
TargetEnvironmentDeleteResponse = unknown
[Link to this property](<#(resource)%20vulnerability_scanner.target_environments%20%3E%20(model)%20target_environment_delete_response%20%3E%20(schema)>)