For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/static-analysis/update-custom-ruleset.md. A documentation index is available at /llms.txt.
homeHomedocsDocsapiAPI
Language
Datadog site

Update Custom Ruleset

WARNINGThis endpoint is in Preview and may introduce breaking changes. If you have any feedback, contact Datadog support.
PATCHhttps://api.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.us3.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.us5.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.datadoghq.eu/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.ap1.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.ap2.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.uk1.datadoghq.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.ddog-gov.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}https://api.us2.ddog-gov.com/api/v2/static-analysis/custom/rulesets/{ruleset_name}

Overview

Update an existing custom ruleset

Arguments

Path Parameters

Name
Type
Description
ruleset_name [required]
string

The ruleset name

Request

Body Data (required)

Field
Type
Description
data
object

Data object for a custom ruleset create or update request. The resource id is required and must equal both attributes.name and, on update, the ruleset_name path parameter; a request that omits it or supplies a different value is rejected with a 412 response.

Response

Successfully updated

Response containing a single custom ruleset.

Field
Type
Description
data [required]
object

A custom static analysis ruleset containing a set of user-defined rules.

Code Example

Update Custom Ruleset
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF
# Path parameters
export ruleset_name="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/static-analysis/custom/rulesets/${ruleset_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "my-ruleset",
      "rules": [
        {
          "id": "my-rule",
          "last_revision": {
            "creation_message": "Initial revision"
          },
          "name": "my-rule"
        }
      ]
    },
    "id": "my-ruleset",
    "type": "custom_ruleset"
  }
}
EOF