--- title: Get a detection description: Retrieve a single governance detection by its unique identifier. breadcrumbs: ドキュメント > API > Get a detection --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get a detection ## 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/governance/detections/{detection_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/governance/detections/{detection_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/governance/detections/{detection_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/governance/detections/{detection_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/governance/detections/{detection_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/governance/detections/{detection_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/governance/detections/{detection_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/governance/detections/{detection_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/governance/detections/{detection_id} | ### Overview Retrieve a single governance detection by its unique identifier. This endpoint requires the `governance_console_read` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------- | ------ | --------------------------------------- | | detection_id [*required*] | string | The unique identifier of the detection. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} A single governance control detection. | Parent field | Field | Type | Description | | ------------ | ------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | A governance control detection resource. | | data | attributes [*required*] | object | The attributes of a governance control detection. | | attributes | assigned_team | string | The identifier of the team the detection is assigned to, if any. | | attributes | assigned_to | string | The identifier of the user the detection is assigned to, if any. | | attributes | assignment_source [*required*] | enum | How the detection's current assignment was determined. Possible values are `auto_resolved`, `manual`, `reassigned`, and `cleared`. Allowed enum values: `auto_resolved`, `manual`, `reassigned`, `cleared`. | | attributes | control_id [*required*] | string | **DEPRECATED**: DEPRECATED: mirrors `detection_type` for backward compatibility; use `detection_type` instead. | | attributes | created_at [*required*] | date-time | The date and time when the detection was created. | | attributes | detection_type [*required*] | string | The type of detection, which determines what condition was detected. | | attributes | display_name [*required*] | string | The human-readable name of the detected resource. | | attributes | exception_at | date-time | The date and time when the detection was marked as an exception, if applicable. | | attributes | exception_by | string | The identifier of the user who marked the detection as an exception, if applicable. | | attributes | metadata | any | Free-form metadata associated with the detection. | | attributes | mitigate_after | date-time | The date and time after which the detection is scheduled to be mitigated, if applicable. | | attributes | mitigated_at | date-time | The date and time when the detection was mitigated, if applicable. | | attributes | priority [*required*] | int64 | The priority of the detection, if set. | | attributes | resource_id [*required*] | string | The identifier of the resource the detection applies to. | | attributes | resource_type [*required*] | string | The type of resource the detection applies to, for example `api_key` or `dashboard`. | | attributes | state [*required*] | enum | The current state of the detection. Possible values are `active`, `exception`, `mitigated`, `inactive`, `obsolete`, `resolved_externally`, and `mitigation_in_progress`. Allowed enum values: `active`, `exception`, `mitigated`, `inactive`, `obsolete`, `resolved_externally`, `mitigation_in_progress`. | | data | id [*required*] | string | The unique identifier of the detection. | | data | type [*required*] | enum | Governance control detection resource type. Allowed enum values: `governance_control_detection`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "assigned_team": "platform-security", "assigned_to": "11111111-2222-3333-4444-555555555555", "assignment_source": "manual", "control_id": "unused_api_keys", "created_at": "2024-03-01T12:00:00Z", "detection_type": "unused_api_keys", "display_name": "CI Deploy Key", "exception_at": "2024-03-05T09:00:00Z", "exception_by": "11111111-2222-3333-4444-555555555555", "metadata": { "region": "us-east-1" }, "mitigate_after": "2024-03-15T00:00:00Z", "mitigated_at": "2024-03-10T15:30:00Z", "priority": 1, "resource_id": "api-key-12345", "resource_type": "api_key", "state": "active" }, "id": "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d", "type": "governance_control_detection" } } ``` {% /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="403" %} Forbidden {% 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" %} 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 %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export detection_id="3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d" # 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/governance/detections/${detection_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get a detection 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.GetGovernanceDetection", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewGovernanceConsoleApi(apiClient) resp, r, err := api.GetGovernanceDetection(ctx, "detection_id") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `GovernanceConsoleApi.GetGovernanceDetection`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `GovernanceConsoleApi.GetGovernanceDetection`:\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 a detection returns "OK" 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.GovernanceControlDetectionResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getGovernanceDetection", true); GovernanceConsoleApi apiInstance = new GovernanceConsoleApi(defaultClient); try { GovernanceControlDetectionResponse result = apiInstance.getGovernanceDetection("3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling GovernanceConsoleApi#getGovernanceDetection"); 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 a detection returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.governance_console_api import GovernanceConsoleApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_governance_detection"] = True with ApiClient(configuration) as api_client: api_instance = GovernanceConsoleApi(api_client) response = api_instance.get_governance_detection( detection_id="detection_id", ) 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 a detection returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_governance_detection".to_sym] = true end api_instance = DatadogAPIClient::V2::GovernanceConsoleAPI.new p api_instance.get_governance_detection("detection_id") ``` #### 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 a detection returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_governance_console::GovernanceConsoleAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_governance_detection", true); let api = GovernanceConsoleAPI::with_config(configuration); let resp = api .get_governance_detection("detection_id".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 a detection 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.getGovernanceDetection"] = true; const apiInstance = new v2.GovernanceConsoleApi(configuration); const params: v2.GovernanceConsoleApiGetGovernanceDetectionRequest = { detectionId: "detection_id", }; apiInstance .getGovernanceDetection(params) .then((data: v2.GovernanceControlDetectionResponse) => { 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 %}