For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/fr/api/latest/security-monitoring/get-a-sast-ruleset.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get a SAST ruleset

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.us3.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.us5.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.datadoghq.eu/api/v2/static-analysis/rulesets/{ruleset_name}https://api.ap1.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.ap2.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.uk1.datadoghq.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.ddog-gov.com/api/v2/static-analysis/rulesets/{ruleset_name}https://api.us2.ddog-gov.com/api/v2/static-analysis/rulesets/{ruleset_name}

Présentation

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

OAuth apps require the code_analysis_read authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Name
Type
Description
ruleset_name [required]
string

The name of the ruleset to retrieve.

Chaînes de requête

Name
Type
Description
include_tests
boolean

When true, test cases for each rule are included in the response.

include_testing_rules
boolean

When true, rules that are in testing mode are included in the response.

Réponse

OK

The response payload containing a single SAST ruleset and its rules.

Champ
Type
Description
data [required]
object

The primary data object representing a SAST ruleset.

Exemple de code

# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export ruleset_name="python-best-practices"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"