Language

한국어 English Français 日本語 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

List codegen rulesets

copy 페이지 복사복사됨

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/static-analysis/codegen/rulesetshttps://api.ap2.datadoghq.com/api/v2/static-analysis/codegen/rulesetshttps://api.datadoghq.eu/api/v2/static-analysis/codegen/rulesetshttps://api.ddog-gov.com/api/v2/static-analysis/codegen/rulesetshttps://api.us2.ddog-gov.com/api/v2/static-analysis/codegen/rulesetshttps://api.uk1.datadoghq.com/api/v2/static-analysis/codegen/rulesetshttps://api.datadoghq.com/api/v2/static-analysis/codegen/rulesetshttps://api.us3.datadoghq.com/api/v2/static-analysis/codegen/rulesetshttps://api.us5.datadoghq.com/api/v2/static-analysis/codegen/rulesets

개요

인증된 사용자의 코드 생성과 관련된 규칙 세트를 가져옵니다.

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

응답

OK

The response payload containing a list of SAST rulesets and their rules.

Expand All

항목

유형

설명

data [required]

[object]

The list of SAST rulesets returned in the response.

attributes [required]

object

The attributes of a SAST ruleset, including its name, description, and rules.

description [required]

string

A detailed description of the ruleset's purpose and the types of issues it targets.

name [required]

string

The unique name of the ruleset.

rules [required]

[object]

The list of static analysis rules included in this ruleset.

arguments [required]

[object]

The list of configurable arguments accepted by this rule.

description

string

A human-readable explanation of the argument's purpose and accepted values.

name

string

The name of the rule argument.

category [required]

string

The category classifying the type of issue this rule detects (e.g., security, style, performance).

checksum [required]

string

A checksum of the rule definition used to detect changes.

code [required]

string

The rule implementation code used by the static analysis engine.

created_at [required]

date-time

The date and time when the rule was created.

created_by [required]

string

The identifier of the user or system that created the rule.

cve

string

The CVE identifier associated with the vulnerability this rule detects, if applicable.

cwe

string

The CWE identifier associated with the weakness category this rule detects, if applicable.

description [required]

string

A detailed explanation of what the rule detects and why it matters.

documentation_url

string

A URL pointing to additional documentation for this rule.

entity_checked

string

The code entity type (e.g., function, class, variable) that this rule inspects.

id [required]

string

The unique identifier of the rule, which is the same as its name.

is_published [required]

boolean

Indicates whether the rule is publicly published and available to all users.

is_testing [required]

boolean

Indicates whether the rule is in testing mode and not yet promoted to production.

language [required]

string

The programming language this rule applies to.

last_updated_at [required]

date-time

The date and time when the rule was last modified.

last_updated_by [required]

string

The identifier of the user or system that last updated the rule.

name [required]

string

The unique name identifying this rule within its ruleset.

regex

string

A regular expression pattern used by the rule for pattern-based detection.

severity [required]

string

The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).

short_description [required]

string

A brief summary of what the rule detects, suitable for display in listings.

should_use_ai_fix [required]

boolean

Indicates whether an AI-generated fix suggestion should be offered for findings from this rule.

tests [required]

[object]

The list of test cases used to validate the rule's behavior.

annotation_count

int64

The expected number of annotations (findings) the rule should produce when run against the test code.

code

string

The source code snippet used as input for the rule test.

filename

string

The filename associated with the test code snippet.

tree_sitter_query

string

The Tree-sitter query expression used by the rule to match code patterns in the AST.

type [required]

string

The rule type indicating the detection mechanism used (e.g., tree_sitter, regex).

short_description [required]

string

A brief summary of the ruleset, suitable for display in listings.

id [required]

string

The unique identifier of the ruleset resource.

type [required]

enum

Rulesets resource type. Allowed enum values: rulesets

default: rulesets

{
  "data": [
    {
      "attributes": {
        "description": "A collection of Python best practice rules.",
        "name": "python-best-practices",
        "rules": [
          {
            "arguments": [
              {
                "description": "string",
                "name": "string"
              }
            ],
            "category": "",
            "checksum": "",
            "code": "",
            "created_at": "",
            "created_by": "",
            "cve": "string",
            "cwe": "string",
            "description": "",
            "documentation_url": "string",
            "entity_checked": "string",
            "id": "",
            "is_published": false,
            "is_testing": false,
            "language": "",
            "last_updated_at": "",
            "last_updated_by": "",
            "name": "",
            "regex": "string",
            "severity": "",
            "short_description": "",
            "should_use_ai_fix": false,
            "tests": [
              {
                "annotation_count": "integer",
                "code": "string",
                "filename": "string"
              }
            ],
            "tree_sitter_query": "string",
            "type": ""
          }
        ],
        "short_description": "Python best practices ruleset."
      },
      "id": "python-best-practices",
      "type": "rulesets"
    }
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Unauthorized

API error response.

Expand All

항목

유형

설명

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 예시

                  # Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/static-analysis/codegen/rulesets" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                
"""
List codegen rulesets returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["list_static_analysis_codegen_rulesets"] = True
with ApiClient(configuration) as api_client:
    api_instance = SecurityMonitoringApi(api_client)
    response = api_instance.list_static_analysis_codegen_rulesets()

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# List codegen rulesets returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
  config.unstable_operations["v2.list_static_analysis_codegen_rulesets".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
p api_instance.list_static_analysis_codegen_rulesets()

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// List codegen rulesets returns "OK" 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.ListStaticAnalysisCodegenRulesets", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewSecurityMonitoringApi(apiClient)
	resp, r, err := api.ListStaticAnalysisCodegenRulesets(ctx)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.ListStaticAnalysisCodegenRulesets`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.ListStaticAnalysisCodegenRulesets`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// List codegen rulesets returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.SastRulesetsResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    defaultClient.setUnstableOperationEnabled("v2.listStaticAnalysisCodegenRulesets", true);
    SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

    try {
      SastRulesetsResponse result = apiInstance.listStaticAnalysisCodegenRulesets();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling SecurityMonitoringApi#listStaticAnalysisCodegenRulesets");
      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 and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
// List codegen rulesets returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.list_static_analysis_codegen_rulesets", true);
    let api = SecurityMonitoringAPI::with_config(configuration);
    let resp = api.list_static_analysis_codegen_rulesets().await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * List codegen rulesets returns "OK" 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.listStaticAnalysisCodegenRulesets"] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

apiInstance
  .listStaticAnalysisCodegenRulesets()
  .then((data: v2.SastRulesetsResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"