config

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

Overview

Name	config
Type	Resource
Id	cloudflare.cloudforce_one.config

Fields

The following fields are returned by SELECT queries:

list

Returns all Scan Configs.

Name	Datatype	Description
id	string	Defines the Config ID. (example: uuid)
account_id	string	(example: abcd1234abcd1234abcd1234abcd1234)
frequency	number	Defines the number of days between each scan (0 = One-off scan). (title: Frequency)
ips	array	Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000. (title: IP List)
ports	array	Defines a list of ports to scan. Valid values are:"default", "all", or a comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). "default" scans the 100 most commonly open ports. (title: Port List)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id
create	insert	account_id, ips
edit	update	account_id, config_id
delete	delete	account_id, config_id

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.
config_id	string	Defines the Config ID.

SELECT examples

list

Returns all Scan Configs.

SELECT
id,
account_id,
frequency,
ips,
ports
FROM cloudflare.cloudforce_one.config
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.cloudforce_one.config (
frequency,
ips,
ports,
account_id
)
SELECT 
{{ frequency }},
'{{ ips }}' /* required */,
'{{ ports }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: config
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the config resource.
  - name: frequency
    value: {{ frequency }}
    description: |
      Defines the number of days between each scan (0 = One-off scan).
  - name: ips
    value:
      - "{{ ips }}"
    description: |
      Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.
  - name: ports
    value:
      - "{{ ports }}"
    description: |
      Defines a list of ports to scan. Valid values are:"default", "all", or a comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). "default" scans the 100 most commonly open ports.

UPDATE examples

edit

No description available.

UPDATE cloudflare.cloudforce_one.config
SET 
frequency = {{ frequency }},
ips = '{{ ips }}',
ports = '{{ ports }}'
WHERE 
account_id = '{{ account_id }}' --required
AND config_id = '{{ config_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

No description available.

DELETE FROM cloudflare.cloudforce_one.config
WHERE account_id = '{{ account_id }}' --required
AND config_id = '{{ config_id }}' --required
;