List control detections

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/governance/control/{detection_type}/detectionshttps://api.ap2.datadoghq.com/api/v2/governance/control/{detection_type}/detectionshttps://api.datadoghq.eu/api/v2/governance/control/{detection_type}/detectionshttps://api.ddog-gov.com/api/v2/governance/control/{detection_type}/detectionshttps://api.us2.ddog-gov.com/api/v2/governance/control/{detection_type}/detectionshttps://api.uk1.datadoghq.com/api/v2/governance/control/{detection_type}/detectionshttps://api.datadoghq.com/api/v2/governance/control/{detection_type}/detectionshttps://api.us3.datadoghq.com/api/v2/governance/control/{detection_type}/detectionshttps://api.us5.datadoghq.com/api/v2/governance/control/{detection_type}/detections

Overview

Retrieve the detections produced by the governance control with the given detection type. Results can be filtered by state and free-text query, sorted, and paginated. This endpoint requires the governance_console_read permission.

Arguments

Path Parameters

Name

Type

Description

detection_type [required]

string

The detection type that identifies the control; for example, unused_api_keys.

Query Strings

Name

Type

Description

filter[state]

string

Restrict the results to detections in the given state.

filter[query]

string

Restrict the results to detections matching the given free-text query.

sort

string

A comma-separated list of attributes to sort detections by. Prefix an attribute with - for descending order.

The attributes available for sorting are id, created_at, assigned_to, detection_type, display_name, exception_at, mitigate_after, mitigated_at, priority, resource_id, and state. Defaults to created_at,-id.

page[number]

integer

The zero-based index of the page to return; the first page is 0.

page[size]

integer

The number of detections to return per page.

Response

OK

A list of governance control detections.

Expand All

Field

Type

Description

data [required]

[object]

An array of governance control detection resources.

attributes [required]

object

The attributes of a governance control detection.

assigned_team

string

The identifier of the team the detection is assigned to, if any.

assigned_to

string

The identifier of the user the detection is assigned to, if any.

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

control_id [required]

string

DEPRECATED: DEPRECATED: mirrors detection_type for backward compatibility; use detection_type instead.

created_at [required]

date-time

The date and time when the detection was created.

detection_type [required]

string

The type of detection, which determines what condition was detected.

display_name [required]

string

The human-readable name of the detected resource.

exception_at

date-time

The date and time when the detection was marked as an exception, if applicable.

exception_by

string

The identifier of the user who marked the detection as an exception, if applicable.

metadata

Free-form metadata associated with the detection.

mitigate_after

date-time

The date and time after which the detection is scheduled to be mitigated, if applicable.

mitigated_at

date-time

The date and time when the detection was mitigated, if applicable.

priority [required]

int64

The priority of the detection, if set.

resource_id [required]

string

The identifier of the resource the detection applies to.

resource_type [required]

string

The type of resource the detection applies to, for example api_key or dashboard.

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

id [required]

string

The unique identifier of the detection.

type [required]

enum

Governance control detection resource type. Allowed enum values: governance_control_detection

{
  "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"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

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

Field

Type

Description

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"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

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

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export detection_type="unused_api_keys"
# 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/governance/control/${detection_type}/detections" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
List control detections returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.governance_console_api import GovernanceConsoleApi

configuration = Configuration()
configuration.unstable_operations["list_governance_control_detections"] = True
with ApiClient(configuration) as api_client:
    api_instance = GovernanceConsoleApi(api_client)
    response = api_instance.list_governance_control_detections(
        detection_type="detection_type",
    )

    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_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# List control detections returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.list_governance_control_detections".to_sym] = true
end
api_instance = DatadogAPIClient::V2::GovernanceConsoleAPI.new
p api_instance.list_governance_control_detections("detection_type")

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_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// List control detections 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())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.ListGovernanceControlDetections", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewGovernanceConsoleApi(apiClient)
	resp, r, err := api.ListGovernanceControlDetections(ctx, "detection_type", *datadogV2.NewListGovernanceControlDetectionsOptionalParameters())

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `GovernanceConsoleApi.ListGovernanceControlDetections`:\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_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// List control detections 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.GovernanceControlDetectionsResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.listGovernanceControlDetections", true);
    GovernanceConsoleApi apiInstance = new GovernanceConsoleApi(defaultClient);

    try {
      GovernanceControlDetectionsResponse result =
          apiInstance.listGovernanceControlDetections("unused_api_keys");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling GovernanceConsoleApi#listGovernanceControlDetections");
      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_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// List control detections returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_governance_console::GovernanceConsoleAPI;
use datadog_api_client::datadogV2::api_governance_console::ListGovernanceControlDetectionsOptionalParams;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.ListGovernanceControlDetections", true);
    let api = GovernanceConsoleAPI::with_config(configuration);
    let resp = api
        .list_governance_control_detections(
            "detection_type".to_string(),
            ListGovernanceControlDetectionsOptionalParams::default(),
        )
        .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 control detections returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.listGovernanceControlDetections"] = true;
const apiInstance = new v2.GovernanceConsoleApi(configuration);

const params: v2.GovernanceConsoleApiListGovernanceControlDetectionsRequest = {
  detectionType: "detection_type",
};

apiInstance
  .listGovernanceControlDetections(params)
  .then((data: v2.GovernanceControlDetectionsResponse) => {
    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_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"