Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
POST https://api.ap1.datadoghq.com/api/v2/governance/detections/mitigate https://api.ap2.datadoghq.com/api/v2/governance/detections/mitigate https://api.datadoghq.eu/api/v2/governance/detections/mitigate https://api.ddog-gov.com/api/v2/governance/detections/mitigate https://api.us2.ddog-gov.com/api/v2/governance/detections/mitigate https://api.uk1.datadoghq.com/api/v2/governance/detections/mitigate https://api.datadoghq.com/api/v2/governance/detections/mitigate https://api.us3.datadoghq.com/api/v2/governance/detections/mitigate https://api.us5.datadoghq.com/api/v2/governance/detections/mitigate
Overview Apply a mitigation to a set of governance detections of a given detection type. When the
mitigation type is omitted, the control’s configured mitigation is used. The request is
accepted for asynchronous processing.
This endpoint requires the governance_console_read permission.
Request Body Data (required)
Expand All
The data of a governance mitigation request.
The attributes of a governance mitigation request.
The identifiers of the detections to mitigate in this request.
detection_type [required ]
The detection type whose detections should be mitigated.
A free-form map of parameter names to their configured values.
The mitigation to apply to the selected detections. Defaults to the control's configured mitigation when omitted.
Governance control detection resource type.
Allowed enum values: governance_control_detection
{
"data" : {
"attributes" : {
"detection_ids" : [
"3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
],
"detection_type" : "unused_api_keys" ,
"mitigation_parameters" : {},
"mitigation_type" : "revoke_api_key"
},
"type" : "governance_control_detection"
}
} 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
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"
}
]
} Forbidden
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
## default
#
# Curl command curl -X POST "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/governance/detections/mitigate " \
-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": {
"detection_ids": [
"3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
],
"detection_type": "unused_api_keys",
"mitigation_parameters": {},
"mitigation_type": "revoke_api_key"
},
"type": "governance_control_detection"
}
}
EOF
"""
Mitigate detections returns "Accepted" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.governance_console_api import GovernanceConsoleApi
from datadog_api_client.v2.model.governance_control_detection_resource_type import (
GovernanceControlDetectionResourceType ,
)
from datadog_api_client.v2.model.governance_mitigation_request import GovernanceMitigationRequest
from datadog_api_client.v2.model.governance_mitigation_request_attributes import GovernanceMitigationRequestAttributes
from datadog_api_client.v2.model.governance_mitigation_request_data import GovernanceMitigationRequestData
body = GovernanceMitigationRequest (
data = GovernanceMitigationRequestData (
attributes = GovernanceMitigationRequestAttributes (
detection_ids = [
"3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" ,
],
detection_type = "unused_api_keys" ,
mitigation_type = "revoke_api_key" ,
),
type = GovernanceControlDetectionResourceType . GOVERNANCE_CONTROL_DETECTION ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "mitigate_governance_detections" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = GovernanceConsoleApi ( api_client )
api_instance . mitigate_governance_detections ( body = body )
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Mitigate detections returns "Accepted" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.mitigate_governance_detections" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: GovernanceConsoleAPI . new
body = DatadogAPIClient :: V2 :: GovernanceMitigationRequest . new ({
data : DatadogAPIClient :: V2 :: GovernanceMitigationRequestData . new ({
attributes : DatadogAPIClient :: V2 :: GovernanceMitigationRequestAttributes . new ({
detection_ids : [
"3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" ,
] ,
detection_type : "unused_api_keys" ,
mitigation_type : "revoke_api_key" ,
}),
type : DatadogAPIClient :: V2 :: GovernanceControlDetectionResourceType :: GOVERNANCE_CONTROL_DETECTION ,
}),
})
p api_instance . mitigate_governance_detections ( body )
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Mitigate detections returns "Accepted" 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 () {
body := datadogV2 . GovernanceMitigationRequest {
Data : datadogV2 . GovernanceMitigationRequestData {
Attributes : & datadogV2 . GovernanceMitigationRequestAttributes {
DetectionIds : [] string {
"3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" ,
},
DetectionType : "unused_api_keys" ,
MitigationType : datadog . PtrString ( "revoke_api_key" ),
},
Type : datadogV2 . GOVERNANCECONTROLDETECTIONRESOURCETYPE_GOVERNANCE_CONTROL_DETECTION ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.MitigateGovernanceDetections" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewGovernanceConsoleApi ( apiClient )
r , err := api . MitigateGovernanceDetections ( ctx , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `GovernanceConsoleApi.MitigateGovernanceDetections`: %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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Mitigate detections returns "Accepted" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.GovernanceConsoleApi ;
import com.datadog.api.client.v2.model.GovernanceControlDetectionResourceType ;
import com.datadog.api.client.v2.model.GovernanceMitigationRequest ;
import com.datadog.api.client.v2.model.GovernanceMitigationRequestAttributes ;
import com.datadog.api.client.v2.model.GovernanceMitigationRequestData ;
import java.util.Collections ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.mitigateGovernanceDetections" , true );
GovernanceConsoleApi apiInstance = new GovernanceConsoleApi ( defaultClient );
GovernanceMitigationRequest body =
new GovernanceMitigationRequest ()
. data (
new GovernanceMitigationRequestData ()
. attributes (
new GovernanceMitigationRequestAttributes ()
. detectionIds (
Collections . singletonList ( "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" ))
. detectionType ( "unused_api_keys" )
. mitigationType ( "revoke_api_key" ))
. type ( GovernanceControlDetectionResourceType . GOVERNANCE_CONTROL_DETECTION ));
try {
apiInstance . mitigateGovernanceDetections ( body );
} catch ( ApiException e ) {
System . err . println (
"Exception when calling GovernanceConsoleApi#mitigateGovernanceDetections" );
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Mitigate detections returns "Accepted" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_governance_console ::GovernanceConsoleAPI ;
use datadog_api_client ::datadogV2 ::model ::GovernanceControlDetectionResourceType ;
use datadog_api_client ::datadogV2 ::model ::GovernanceMitigationRequest ;
use datadog_api_client ::datadogV2 ::model ::GovernanceMitigationRequestAttributes ;
use datadog_api_client ::datadogV2 ::model ::GovernanceMitigationRequestData ;
#[tokio::main]
async fn main () {
let body = GovernanceMitigationRequest ::new (
GovernanceMitigationRequestData ::new (
GovernanceControlDetectionResourceType ::GOVERNANCE_CONTROL_DETECTION ,
)
. attributes (
GovernanceMitigationRequestAttributes ::new (
vec! [ "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" . to_string ()],
"unused_api_keys" . to_string (),
)
. mitigation_type ( "revoke_api_key" . to_string ()),
),
);
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.MitigateGovernanceDetections" , true );
let api = GovernanceConsoleAPI ::with_config ( configuration );
let resp = api . mitigate_governance_detections ( body ). 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Mitigate detections returns "Accepted" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.mitigateGovernanceDetections" ] = true ;
const apiInstance = new v2 . GovernanceConsoleApi ( configuration );
const params : v2.GovernanceConsoleApiMitigateGovernanceDetectionsRequest = {
body : {
data : {
attributes : {
detectionIds : [ "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" ],
detectionType : "unused_api_keys" ,
mitigationType : "revoke_api_key" ,
},
type : "governance_control_detection" ,
},
},
};
apiInstance
. mitigateGovernanceDetections ( 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"