static_analysis_custom_ruleset_rule_revisions

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

Overview

Name	static_analysis_custom_ruleset_rule_revisions
Type	Resource
Id	datadog.security.static_analysis_custom_ruleset_rule_revisions

Fields

The following fields are returned by SELECT queries:

get_custom_rule_revision

Name	Datatype	Description
id	string	Revision identifier (example: revision-123)
attributes	object	Attributes of a custom rule revision, including code, metadata, and test cases.
type	string	Resource type (custom_rule_revision) (example: custom_rule_revision)

list_custom_rule_revisions

Name	Datatype	Description
id	string	Revision identifier (example: revision-123)
attributes	object	Attributes of a custom rule revision, including code, metadata, and test cases.
type	string	Resource type (custom_rule_revision) (example: custom_rule_revision)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_rule_revision	select	ruleset_name, rule_name, id		Get a specific revision of a custom rule
list_custom_rule_revisions	select	ruleset_name, rule_name	page[offset], page[limit]	Get all revisions for a custom rule
create_custom_rule_revision	replace	ruleset_name, rule_name		Create a new revision for a custom rule
revert_custom_rule_revision	exec	ruleset_name, rule_name		Revert a custom rule to a previous revision

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
id	string	The revision ID
rule_name	string	The rule name
ruleset_name	string	The ruleset name
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
page[limit]	integer (int64)	Pagination limit
page[offset]	integer (int64)	Pagination offset

SELECT examples

get_custom_rule_revision

Get a specific revision of a custom rule

SELECT
id,
attributes,
type
FROM datadog.security.static_analysis_custom_ruleset_rule_revisions
WHERE ruleset_name = '{{ ruleset_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND id = '{{ id }}' -- required
;

list_custom_rule_revisions

Get all revisions for a custom rule

SELECT
id,
attributes,
type
FROM datadog.security.static_analysis_custom_ruleset_rule_revisions
WHERE ruleset_name = '{{ ruleset_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
;

REPLACE examples

create_custom_rule_revision

Create a new revision for a custom rule

REPLACE datadog.security.static_analysis_custom_ruleset_rule_revisions
SET 
data = '{{ data }}'
WHERE 
ruleset_name = '{{ ruleset_name }}' --required
AND rule_name = '{{ rule_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

revert_custom_rule_revision

Revert a custom rule to a previous revision

EXEC datadog.security.static_analysis_custom_ruleset_rule_revisions.revert_custom_rule_revision 
@ruleset_name='{{ ruleset_name }}' --required, 
@rule_name='{{ rule_name }}' --required, 
@@json=
'{
"data": "{{ data }}"
}'
;