scorecard_rules

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

Overview

Name	scorecard_rules
Type	Resource
Id	datadog.apm.scorecard_rules

Fields

The following fields are returned by SELECT queries:

list_scorecard_rules

Name	Datatype	Description
id	string	The unique ID for a scorecard rule. (example: q8MQxk8TCqrHnWkx)
attributes	object	Details of a rule.
relationships	object	Scorecard create rule response relationship.
type	string	The JSON:API type for scorecard rules. (rule) (default: rule, example: rule)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scorecard_rules	select		page[size], page[offset], include, filter[rule][id], filter[rule][enabled], filter[rule][custom], filter[rule][name], filter[rule][description], fields[rule], fields[scorecard]	Fetch all rules.
create_scorecard_rule	insert			Creates a new rule.
update_scorecard_rule	replace	rule_id		Updates an existing rule.
delete_scorecard_rule	delete	rule_id		Deletes a single rule.

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
rule_id	string	The ID of the rule.
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.
fields[rule]	string	Return only specific fields in the response for rule attributes.
fields[scorecard]	string	Return only specific fields in the included response for scorecard attributes.
filter[rule][custom]	boolean	Filter for custom rules only.
filter[rule][description]	string	Filter rules on the rule description.
filter[rule][enabled]	boolean	Filter for enabled rules only.
filter[rule][id]	string	Filter the rules on a rule ID.
filter[rule][name]	string	Filter rules on the rule name.
include	string	Include related scorecard details in the response.
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.

SELECT examples

list_scorecard_rules

Fetch all rules.

SELECT
id,
attributes,
relationships,
type
FROM datadog.apm.scorecard_rules
WHERE page[size] = '{{ page[size] }}'
AND page[offset] = '{{ page[offset] }}'
AND include = '{{ include }}'
AND filter[rule][id] = '{{ filter[rule][id] }}'
AND filter[rule][enabled] = '{{ filter[rule][enabled] }}'
AND filter[rule][custom] = '{{ filter[rule][custom] }}'
AND filter[rule][name] = '{{ filter[rule][name] }}'
AND filter[rule][description] = '{{ filter[rule][description] }}'
AND fields[rule] = '{{ fields[rule] }}'
AND fields[scorecard] = '{{ fields[scorecard] }}'
;

INSERT examples

create_scorecard_rule

Creates a new rule.

INSERT INTO datadog.apm.scorecard_rules (
data
)
SELECT 
'{{ data }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: scorecard_rules
props:
  - name: data
    description: |
      Scorecard create rule request data.
    value:
      attributes:
        description: "{{ description }}"
        enabled: {{ enabled }}
        level: {{ level }}
        name: "{{ name }}"
        owner: "{{ owner }}"
        scope_query: "{{ scope_query }}"
        scorecard_name: "{{ scorecard_name }}"
      type: "{{ type }}"

REPLACE examples

update_scorecard_rule

Updates an existing rule.

REPLACE datadog.apm.scorecard_rules
SET 
data = '{{ data }}'
WHERE 
rule_id = '{{ rule_id }}' --required
RETURNING
data;

DELETE examples

delete_scorecard_rule

Deletes a single rule.

DELETE FROM datadog.apm.scorecard_rules
WHERE rule_id = '{{ rule_id }}' --required
;