API Reference

Vulnerability Scanner

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Target Environments

List Target Environments

client.vulnerabilityScanner.targetEnvironments.list(TargetEnvironmentListParams { account_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<TargetEnvironmentListResponse { id, name, target, description } >

GET/accounts/{account_id}/vuln_scanner/target_environments

Create Target Environment

client.vulnerabilityScanner.targetEnvironments.create(TargetEnvironmentCreateParams { account_id, name, target, description } params, RequestOptionsoptions?): TargetEnvironmentCreateResponse { id, name, target, description }

POST/accounts/{account_id}/vuln_scanner/target_environments

Get Target Environment

client.vulnerabilityScanner.targetEnvironments.get(stringtargetEnvironmentId, TargetEnvironmentGetParams { account_id } params?, RequestOptionsoptions?): TargetEnvironmentGetResponse { id, name, target, description }

GET/accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}

Update Target Environment

client.vulnerabilityScanner.targetEnvironments.update(stringtargetEnvironmentId, TargetEnvironmentUpdateParams { account_id, name, target, description } params, RequestOptionsoptions?): TargetEnvironmentUpdateResponse { id, name, target, description }

PUT/accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}

Edit Target Environment

client.vulnerabilityScanner.targetEnvironments.edit(stringtargetEnvironmentId, TargetEnvironmentEditParams { account_id, description, name, target } params, RequestOptionsoptions?): TargetEnvironmentEditResponse { id, name, target, description }

PATCH/accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}

Delete Target Environment

client.vulnerabilityScanner.targetEnvironments.delete(stringtargetEnvironmentId, TargetEnvironmentDeleteParams { account_id } params?, RequestOptionsoptions?): TargetEnvironmentDeleteResponse | null

DELETE/accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}

ModelsExpand Collapse

TargetEnvironmentListResponse { id, name, target, description }

id: string

Target environment identifier.

formatuuid

name: string

Human-readable name.

target: Target { type, zone_tag }

Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

type: "zone"

zone_tag: string

Cloudflare zone tag. The zone must belong to the account.

maxLength32

description?: string | null

Optional description providing additional context.

TargetEnvironmentCreateResponse { id, name, target, description }

id: string

Target environment identifier.

formatuuid

name: string

Human-readable name.

target: Target { type, zone_tag }

Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

type: "zone"

zone_tag: string

Cloudflare zone tag. The zone must belong to the account.

maxLength32

description?: string | null

Optional description providing additional context.

TargetEnvironmentGetResponse { id, name, target, description }

id: string

Target environment identifier.

formatuuid

name: string

Human-readable name.

target: Target { type, zone_tag }

Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

type: "zone"

zone_tag: string

Cloudflare zone tag. The zone must belong to the account.

maxLength32

description?: string | null

Optional description providing additional context.

TargetEnvironmentUpdateResponse { id, name, target, description }

id: string

Target environment identifier.

formatuuid

name: string

Human-readable name.

target: Target { type, zone_tag }

Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

type: "zone"

zone_tag: string

Cloudflare zone tag. The zone must belong to the account.

maxLength32

description?: string | null

Optional description providing additional context.

TargetEnvironmentEditResponse { id, name, target, description }

id: string

Target environment identifier.

formatuuid

name: string

Human-readable name.

target: Target { type, zone_tag }

Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

type: "zone"

zone_tag: string

Cloudflare zone tag. The zone must belong to the account.

maxLength32

description?: string | null

Optional description providing additional context.

TargetEnvironmentDeleteResponse = unknown