This endpoint is in Preview and may introduce breaking changes.
If you have any feedback, contact Datadog support .
DELETE 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.datadoghq.eu/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} https://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}
Overview Delete a custom ruleset
Arguments Path Parameters Response Bad request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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 - custom rules not enabled
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} Ruleset not found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export ruleset_name = "CHANGE_ME" # Curl command curl -X DELETE "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.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/static-analysis/custom/rulesets/${ruleset_name} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Delete Custom Ruleset returns "Successfully deleted" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
configuration = Configuration ()
configuration . unstable_operations [ "delete_custom_ruleset" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = StaticAnalysisApi ( api_client )
api_instance . delete_custom_ruleset (
ruleset_name = "ruleset_name" ,
)
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Delete Custom Ruleset returns "Successfully deleted" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.delete_custom_ruleset" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: StaticAnalysisAPI . new
p api_instance . delete_custom_ruleset ( "ruleset_name" )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Delete Custom Ruleset returns "Successfully deleted" response
package main
import (
"context"
"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 ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.DeleteCustomRuleset" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewStaticAnalysisApi ( apiClient )
r , err := api . DeleteCustomRuleset ( ctx , "ruleset_name" )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `StaticAnalysisApi.DeleteCustomRuleset`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Delete Custom Ruleset returns "Successfully deleted" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.StaticAnalysisApi ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.deleteCustomRuleset" , true );
StaticAnalysisApi apiInstance = new StaticAnalysisApi ( defaultClient );
try {
apiInstance . deleteCustomRuleset ( "ruleset_name" );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling StaticAnalysisApi#deleteCustomRuleset" );
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// Delete Custom Ruleset returns "Successfully deleted" 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.DeleteCustomRuleset" , true );
let api = StaticAnalysisAPI ::with_config ( configuration );
let resp = api . delete_custom_ruleset ( "ruleset_name" . to_string ()). 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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Delete Custom Ruleset returns "Successfully deleted" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.deleteCustomRuleset" ] = true ;
const apiInstance = new v2 . StaticAnalysisApi ( configuration );
const params : v2.StaticAnalysisApiDeleteCustomRulesetRequest = {
rulesetName : "ruleset_name" ,
};
apiInstance
. deleteCustomRuleset ( params )
. then (( data : any ) => {
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"