target_environments

Creates, updates, deletes, gets or lists a target_environments resource.

Overview

Name	target_environments
Type	Resource
Id	cloudflare.vulnerability_scanner.target_environments

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
id	string (uuid)	Target environment identifier.
name	string	Human-readable name. (example: Production Zone)
description	string	Optional description providing additional context. (example: Main production environment)
target	object	Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

list

Successful response.

Name	Datatype	Description
id	string (uuid)	Target environment identifier.
name	string	Human-readable name. (example: Production Zone)
description	string	Optional description providing additional context. (example: Main production environment)
target	object	Identifies the Cloudflare asset to scan. Uses a type discriminator. Currently the service supports only zone targets.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, target_environment_id		Returns a single target environment by ID.
list	select	account_id	page, per_page	Returns all target environments for the account.
create	insert	account_id, name, target		Creates a new target environment for the account.
edit	update	account_id, target_environment_id		Updates a target environment with only the provided fields; omitted fields remain unchanged.
update	replace	account_id, target_environment_id, name, target		Replaces a target environment. All fields must be provided.
delete	delete	account_id, target_environment_id		Removes a target environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
target_environment_id	string (uuid)	Target environment identifier.
page	integer	Page number of paginated results.
per_page	integer	Number of results per page.

SELECT examples

get

Returns a single target environment by ID.

SELECT
id,
name,
description,
target
FROM cloudflare.vulnerability_scanner.target_environments
WHERE account_id = '{{ account_id }}' -- required
AND target_environment_id = '{{ target_environment_id }}' -- required
;

list

Returns all target environments for the account.

SELECT
id,
name,
description,
target
FROM cloudflare.vulnerability_scanner.target_environments
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Creates a new target environment for the account.

INSERT INTO cloudflare.vulnerability_scanner.target_environments (
description,
name,
target,
account_id
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ target }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: target_environments
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the target_environments resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional description.
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name.
  - name: target
    description: |
      Identifies the Cloudflare asset to scan. Uses a `type` discriminator. Currently the service supports only `zone` targets.
    value:
      type: "{{ type }}"
      zone_tag: "{{ zone_tag }}"

UPDATE examples

edit

Updates a target environment with only the provided fields; omitted fields remain unchanged.

UPDATE cloudflare.vulnerability_scanner.target_environments
SET 
description = '{{ description }}',
name = '{{ name }}',
target = '{{ target }}'
WHERE 
account_id = '{{ account_id }}' --required
AND target_environment_id = '{{ target_environment_id }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

REPLACE examples

update

Replaces a target environment. All fields must be provided.

REPLACE cloudflare.vulnerability_scanner.target_environments
SET 
description = '{{ description }}',
name = '{{ name }}',
target = '{{ target }}'
WHERE 
account_id = '{{ account_id }}' --required
AND target_environment_id = '{{ target_environment_id }}' --required
AND name = '{{ name }}' --required
AND target = '{{ target }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

DELETE examples

delete

Removes a target environment.

DELETE FROM cloudflare.vulnerability_scanner.target_environments
WHERE account_id = '{{ account_id }}' --required
AND target_environment_id = '{{ target_environment_id }}' --required
;