--- title: Create an AI custom rule revision description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Static Analysis --- # Create an AI custom rule revision{% #create-an-ai-custom-rule-revision %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions | ### Overview Create a new revision for an AI custom rule. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | ----------------- | | ruleset_name [*required*] | string | The ruleset name. | | rule_name [*required*] | string | The rule name. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | | | data | object | Request data for creating an AI custom rule revision. | | data | attributes | object | Attributes for creating an AI custom rule revision. | | attributes | category [*required*] | enum | Rule category Allowed enum values: `SECURITY,BEST_PRACTICES,CODE_STYLE,ERROR_PRONE,PERFORMANCE` | | attributes | content [*required*] | string | Base64-encoded AI model content for this revision. | | attributes | cwe | string | The associated CWE identifier. | | attributes | description [*required*] | string | Base64-encoded full description. | | attributes | directories [*required*] | [string] | Directory patterns this rule applies to. | | attributes | execution_mode [*required*] | enum | The execution mode for an AI rule revision. Allowed enum values: `auto,manual,always` | | attributes | globs [*required*] | [string] | File glob patterns this rule applies to. | | attributes | is_published [*required*] | boolean | Whether this revision is published. | | attributes | is_testing [*required*] | boolean | Whether this revision is for testing only. | | attributes | severity [*required*] | enum | Rule severity Allowed enum values: `ERROR,WARNING,NOTICE` | | attributes | short_description [*required*] | string | Base64-encoded short description. | | attributes | version_id | int64 | The version identifier for this revision. | | data | id | string | The revision identifier. | | data | type | enum | AI custom rule revision resource type. Allowed enum values: `ai_rule_revision` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "category": "SECURITY", "content": "Content", "cwe": "79", "description": "Ruleset description", "directories": [ [] ], "execution_mode": "auto", "globs": [ "**/*.py" ], "is_published": false, "is_testing": false, "severity": "ERROR", "short_description": "Ruleset short description", "version_id": 1 }, "id": "revision-abc-123", "type": "ai_rule_revision" } } ``` {% /tab %} ### Response {% tab title="200" %} Successfully created {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Rule not found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="500" %} Internal Server Error {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export ruleset_name="my-ai-ruleset" export rule_name="my-ai-rule" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/static-analysis/ai/rulesets/${ruleset_name}/rules/${rule_name}/revisions" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "category": "SECURITY", "content": "Content", "description": "Ruleset description", "directories": [], "execution_mode": "auto", "globs": [ "**/*.py" ], "is_published": false, "is_testing": false, "severity": "ERROR", "short_description": "Ruleset short description", "version_id": 1 }, "id": "revision-abc-123", "type": "ai_rule_revision" } } EOF {% /tab %}