static_analysis_rulesets

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

Overview

Name	static_analysis_rulesets
Type	Resource
Id	datadog.security.static_analysis_rulesets

Fields

The following fields are returned by SELECT queries:

get_static_analysis_ruleset

Name	Datatype	Description
id	string	The unique identifier of the ruleset resource. (example: python-best-practices)
attributes	object	The attributes of a SAST ruleset, including its name, description, and rules.
type	string	Rulesets resource type. (rulesets) (default: rulesets, example: rulesets)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_static_analysis_ruleset	select	ruleset_name	include_tests, include_testing_rules	Get a SAST ruleset by name, including all its rules.
list_multiple_rulesets	insert			Get rules for multiple rulesets in batch.

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
ruleset_name	string	The name of the ruleset to retrieve.
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.
include_testing_rules	boolean	When true, rules that are in testing mode are included in the response.
include_tests	boolean	When true, test cases for each rule are included in the response.

SELECT examples

get_static_analysis_ruleset

Get a SAST ruleset by name, including all its rules.

SELECT
id,
attributes,
type
FROM datadog.security.static_analysis_rulesets
WHERE ruleset_name = '{{ ruleset_name }}' -- required
AND include_tests = '{{ include_tests }}'
AND include_testing_rules = '{{ include_testing_rules }}'
;

INSERT examples

list_multiple_rulesets

Get rules for multiple rulesets in batch.

INSERT INTO datadog.security.static_analysis_rulesets (
data
)
SELECT 
'{{ data }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: static_analysis_rulesets
props:
  - name: data
    description: |
      The primary data object in the get-multiple-rulesets request, containing request attributes and resource type.
    value:
      attributes:
        include_testing_rules: {{ include_testing_rules }}
        include_tests: {{ include_tests }}
        rulesets:
          - "{{ rulesets }}"
      id: "{{ id }}"
      type: "{{ type }}"