--- title: Get an AI custom ruleset description: Get an AI custom ruleset by name. breadcrumbs: ドキュメント > API > Get an AI custom ruleset --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Get an AI custom ruleset ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/static-analysis/ai/rulesets/{ruleset_name} | ### Overview Get an AI custom ruleset by name. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------- | ------ | ----------------- | | ruleset_name [*required*] | string | The ruleset name. | ### Response {% tabs %} {% tab label="200" %} Successful response {% tabs %} {% tab label="Model" %} Response containing a single AI custom ruleset. | Parent field | Field | Type | Description | | ------------- | ------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Response data for an AI custom ruleset. | | data | attributes [*required*] | object | Response attributes of an AI custom ruleset. | | attributes | created_at [*required*] | date-time | The creation timestamp. | | attributes | created_by [*required*] | string | The identifier of the user who created the ruleset. | | attributes | description [*required*] | string | Base64-encoded full description of the ruleset. | | attributes | name [*required*] | string | The ruleset name. | | attributes | rules [*required*] | [object] | The rules contained in the ruleset. | | rules | created_at [*required*] | date-time | The creation timestamp. | | rules | created_by [*required*] | string | The identifier of the user who created the rule. | | rules | last_revision [*required*] | object | The most recent revision of the rule. | | last_revision | category [*required*] | enum | Rule category Allowed enum values: `SECURITY`, `BEST_PRACTICES`, `CODE_STYLE`, `ERROR_PRONE`, `PERFORMANCE`. | | last_revision | checksum [*required*] | string | Checksum of the revision content. | | last_revision | content [*required*] | string | Base64-encoded AI model content for this revision. | | last_revision | created_at [*required*] | date-time | The creation timestamp. | | last_revision | created_by [*required*] | string | The identifier of the user who created the revision. | | last_revision | cwe [*required*] | string | The associated CWE identifier. | | last_revision | description [*required*] | string | Base64-encoded full description. | | last_revision | directories [*required*] | [string] | Directory patterns this rule applies to. | | last_revision | execution_mode [*required*] | enum | The execution mode for an AI rule revision. Allowed enum values: `auto`, `manual`, `always`. | | last_revision | globs [*required*] | [string] | File glob patterns this rule applies to. | | last_revision | is_default [*required*] | boolean | Whether this is a default Datadog rule. | | last_revision | is_published [*required*] | boolean | Whether this revision is published. | | last_revision | is_testing [*required*] | boolean | Whether this revision is for testing only. | | last_revision | severity [*required*] | enum | Rule severity Allowed enum values: `ERROR`, `WARNING`, `NOTICE`, `NONE`. | | last_revision | short_description [*required*] | string | Base64-encoded short description. | | last_revision | version_id [*required*] | int64 | The version identifier for this revision. | | rules | name [*required*] | string | The rule name. | | attributes | short_description [*required*] | string | Base64-encoded short description of the ruleset. | | data | id [*required*] | string | The ruleset identifier. | | data | type [*required*] | enum | AI custom ruleset resource type. Allowed enum values: `ai_ruleset`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "created_at": "2024-01-01T00:00:00+00:00", "created_by": "example-handle", "description": "Ruleset description", "name": "my-ai-ruleset", "rules": [ { "created_at": "2024-01-01T00:00:00+00:00", "created_by": "example-handle", "last_revision": { "category": "SECURITY", "checksum": "abc123def456", "content": "Content", "created_at": "2024-01-01T00:00:00+00:00", "created_by": "example-handle", "cwe": "79", "description": "Ruleset description", "directories": [ [] ], "execution_mode": "auto", "globs": [ "**/*.py" ], "is_default": false, "is_published": false, "is_testing": false, "severity": "ERROR", "short_description": "Ruleset short description", "version_id": 1 }, "name": "my-ai-rule" } ], "short_description": "Ruleset short description" }, "id": "my-ai-ruleset", "type": "ai_ruleset" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="401" %} Unauthorized {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="404" %} Ruleset not found {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="500" %} Internal Server Error {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export ruleset_name="my-ai-ruleset" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/static-analysis/ai/rulesets/${ruleset_name}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get an AI custom ruleset returns "Successful response" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetAiCustomRuleset", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewStaticAnalysisApi(apiClient) resp, r, err := api.GetAiCustomRuleset(ctx, "my-ai-ruleset") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `StaticAnalysisApi.GetAiCustomRuleset`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `StaticAnalysisApi.GetAiCustomRuleset`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get an AI custom ruleset returns "Successful response" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.StaticAnalysisApi; import com.datadog.api.client.v2.model.AiCustomRulesetResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getAiCustomRuleset", true); StaticAnalysisApi apiInstance = new StaticAnalysisApi(defaultClient); try { AiCustomRulesetResponse result = apiInstance.getAiCustomRuleset("my-ai-ruleset"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling StaticAnalysisApi#getAiCustomRuleset"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get an AI custom ruleset returns "Successful response" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_ai_custom_ruleset"] = True with ApiClient(configuration) as api_client: api_instance = StaticAnalysisApi(api_client) response = api_instance.get_ai_custom_ruleset( ruleset_name="my-ai-ruleset", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get an AI custom ruleset returns "Successful response" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_ai_custom_ruleset".to_sym] = true end api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new p api_instance.get_ai_custom_ruleset("my-ai-ruleset") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get an AI custom ruleset returns "Successful response" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_static_analysis::StaticAnalysisAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_ai_custom_ruleset", true); let api = StaticAnalysisAPI::with_config(configuration); let resp = api.get_ai_custom_ruleset("my-ai-ruleset".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get an AI custom ruleset returns "Successful response" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.getAiCustomRuleset"] = true; const apiInstance = new v2.StaticAnalysisApi(configuration); const params: v2.StaticAnalysisApiGetAiCustomRulesetRequest = { rulesetName: "my-ai-ruleset", }; apiInstance .getAiCustomRuleset(params) .then((data: v2.AiCustomRulesetResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}