scan_review

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

Overview

Name	scan_review
Type	Resource
Id	cloudflare.dns.scan_review

Fields

The following fields are returned by SELECT queries:

list

List of discovered DNS records

Name	Datatype	Description
id	string	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
name	string	Complete DNS record name, including the zone name, in Punycode. (example: example.com)
comment	string	Comments or notes about the DNS record. This field has no effect on DNS responses. (example: Domain verification record)
comment_modified_on	string (date-time)	When the record comment was last modified. Omitted if there is no comment. (example: 2024-01-01T05:20:00.12345Z, x-stainless-terraform-configurability: computed)
content	string (ipv4)	A valid IPv4 address. (example: 198.51.100.4)
created_on	string (date-time)	When the record was created. (example: 2014-01-01T05:20:00.12345Z, x-stainless-terraform-configurability: computed)
data	object	Components of a CAA record.
meta	object	Extra Cloudflare-specific information about the record. (x-stainless-terraform-configurability: computed)
modified_on	string (date-time)	When the record was last modified. (example: 2014-01-01T05:20:00.12345Z, x-stainless-terraform-configurability: computed)
priority	number	Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map.
private_routing	boolean	Enables private network routing to the origin.
proxiable	boolean	Whether the record can be proxied by Cloudflare or not. (x-stainless-terraform-configurability: computed)
proxied	boolean	Whether the record is receiving the performance and security benefits of Cloudflare.
settings	object	Settings for the DNS record.
tags	array	Custom tags for the DNS record. This field has no effect on DNS responses. (x-stainless-collection-type: set)
tags_modified_on	string (date-time)	When the record tags were last modified. Omitted if there are no tags. (example: 2025-01-01T05:20:00.12345Z, x-stainless-terraform-configurability: computed)
ttl	number	Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones. (1)
type	string	Record type. (A) (example: A)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via POST /scan/review. Additional records may be discovered by the scan later.
scan_review	insert	zone_id		Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted.

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
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via POST /scan/review. Additional records may be discovered by the scan later.

SELECT
id,
name,
comment,
comment_modified_on,
content,
created_on,
data,
meta,
modified_on,
priority,
private_routing,
proxiable,
proxied,
settings,
tags,
tags_modified_on,
ttl,
type
FROM cloudflare.dns.scan_review
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

scan_review

Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted.

INSERT INTO cloudflare.dns.scan_review (
accepts,
rejects,
zone_id
)
SELECT 
'{{ accepts }}',
'{{ rejects }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: scan_review
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the scan_review resource.
  - name: accepts
    value:
      - comment: "{{ comment }}"
        name: "{{ name }}"
        proxied: {{ proxied }}
        settings:
          ipv4_only: {{ ipv4_only }}
          ipv6_only: {{ ipv6_only }}
        tags: "{{ tags }}"
        ttl: {{ ttl }}
        content: "{{ content }}"
        private_routing: {{ private_routing }}
        type: "{{ type }}"
        priority: {{ priority }}
        data:
          flags: {{ flags }}
          tag: "{{ tag }}"
          value: "{{ value }}"
  - name: rejects
    value:
      - id: "{{ id }}"