For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/security-monitoring/get-dataset-dependencies.md. A documentation index is available at /llms.txt.

Language

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

Datadog Site

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

Get dataset dependencies

copy Image Copy pageCopied

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/security_monitoring/datasets/dependencieshttps://api.ap2.datadoghq.com/api/v2/security_monitoring/datasets/dependencieshttps://api.datadoghq.eu/api/v2/security_monitoring/datasets/dependencieshttps://api.ddog-gov.com/api/v2/security_monitoring/datasets/dependencieshttps://api.us2.ddog-gov.com/api/v2/security_monitoring/datasets/dependencieshttps://api.uk1.datadoghq.com/api/v2/security_monitoring/datasets/dependencieshttps://api.datadoghq.com/api/v2/security_monitoring/datasets/dependencieshttps://api.us3.datadoghq.com/api/v2/security_monitoring/datasets/dependencieshttps://api.us5.datadoghq.com/api/v2/security_monitoring/datasets/dependencies

Overview

Return, for each of the requested datasets, the list of detection rules that depend on it. Useful for understanding the impact of updating or deleting a dataset. This endpoint requires any of the following permissions:

  • security_monitoring_rules_read
  • security_monitoring_dataset_read

    • OAuth apps require the security_monitoring_rules_read authorization scope to access this endpoint.

    Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data [required]

    object

    The data wrapper of a dataset dependencies request.

    attributes [required]

    object

    The attributes of a dataset dependencies request.

    datasetIds [required]

    [string]

    The list of dataset UUIDs to query dependencies for. Must contain between 1 and 100 items.

    {
  "data": {
    "attributes": {
      "datasetIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  }
}

    Response

    OK

    Response listing the dependents of each requested dataset.

    Expand All

    Field

    Type

    Description

    data [required]

    [object]

    The list of dataset dependents entries.

    attributes [required]

    object

    The attributes of a dataset dependents entry.

    count [required]

    int64

    The number of resources that depend on the dataset.

    datasetId [required]

    string

    The UUID of the dataset whose dependencies are being reported.

    ids [required]

    [string]

    The list of resource IDs that depend on the dataset.

    resource_type [required]

    string

    The type of resource that depends on the dataset.

    id [required]

    string

    The UUID of the dataset.

    type [required]

    enum

    The type of resource for a dataset dependents entry. Allowed enum values: datasetDependents

    {
  "data": [
    {
      "attributes": {
        "count": 0,
        "datasetId": "123e4567-e89b-12d3-a456-426614174000",
        "ids": [
          []
        ],
        "resource_type": "security_detection_rule"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "datasetDependents"
    }
  ]
}

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

    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

                      ## default
# 

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

    # 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/security_monitoring/datasets/dependencies" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "datasetIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  }
}
EOF
    
    
                
    """
Get dataset dependencies 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
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_request import (
    SecurityMonitoringDatasetDependenciesRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_request_attributes import (
    SecurityMonitoringDatasetDependenciesRequestAttributes,
)
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_request_data import (
    SecurityMonitoringDatasetDependenciesRequestData,
)

body = SecurityMonitoringDatasetDependenciesRequest(
    data=SecurityMonitoringDatasetDependenciesRequestData(
        attributes=SecurityMonitoringDatasetDependenciesRequestAttributes(
            dataset_ids=[
                "123e4567-e89b-12d3-a456-426614174000",
            ],
        ),
    ),
)

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

    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"
    # Get dataset dependencies returns "OK" response

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

body = DatadogAPIClient::V2::SecurityMonitoringDatasetDependenciesRequest.new({
  data: DatadogAPIClient::V2::SecurityMonitoringDatasetDependenciesRequestData.new({
    attributes: DatadogAPIClient::V2::SecurityMonitoringDatasetDependenciesRequestAttributes.new({
      dataset_ids: [
        "123e4567-e89b-12d3-a456-426614174000",
      ],
    }),
  }),
})
p api_instance.batch_get_security_monitoring_dataset_dependencies(body)

    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"
    // Get dataset dependencies 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() {
	body := datadogV2.SecurityMonitoringDatasetDependenciesRequest{
		Data: datadogV2.SecurityMonitoringDatasetDependenciesRequestData{
			Attributes: datadogV2.SecurityMonitoringDatasetDependenciesRequestAttributes{
				DatasetIds: []string{
					"123e4567-e89b-12d3-a456-426614174000",
				},
			},
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.BatchGetSecurityMonitoringDatasetDependencies", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewSecurityMonitoringApi(apiClient)
	resp, r, err := api.BatchGetSecurityMonitoringDatasetDependencies(ctx, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.BatchGetSecurityMonitoringDatasetDependencies`:\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"
    // Get dataset dependencies 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.SecurityMonitoringDatasetDependenciesRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesRequestAttributes;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesRequestData;
import com.datadog.api.client.v2.model.SecurityMonitoringDatasetDependenciesResponse;
import java.util.Collections;

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

    SecurityMonitoringDatasetDependenciesRequest body =
        new SecurityMonitoringDatasetDependenciesRequest()
            .data(
                new SecurityMonitoringDatasetDependenciesRequestData()
                    .attributes(
                        new SecurityMonitoringDatasetDependenciesRequestAttributes()
                            .datasetIds(
                                Collections.singletonList(
                                    "123e4567-e89b-12d3-a456-426614174000"))));

    try {
      SecurityMonitoringDatasetDependenciesResponse result =
          apiInstance.batchGetSecurityMonitoringDatasetDependencies(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling"
              + " SecurityMonitoringApi#batchGetSecurityMonitoringDatasetDependencies");
      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"
    // Get dataset dependencies returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
use datadog_api_client::datadogV2::model::SecurityMonitoringDatasetDependenciesRequest;
use datadog_api_client::datadogV2::model::SecurityMonitoringDatasetDependenciesRequestAttributes;
use datadog_api_client::datadogV2::model::SecurityMonitoringDatasetDependenciesRequestData;

#[tokio::main]
async fn main() {
    let body = SecurityMonitoringDatasetDependenciesRequest::new(
        SecurityMonitoringDatasetDependenciesRequestData::new(
            SecurityMonitoringDatasetDependenciesRequestAttributes::new(vec![
                "123e4567-e89b-12d3-a456-426614174000".to_string(),
            ]),
        ),
    );
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled(
        "v2.batch_get_security_monitoring_dataset_dependencies",
        true,
    );
    let api = SecurityMonitoringAPI::with_config(configuration);
    let resp = api
        .batch_get_security_monitoring_dataset_dependencies(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.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
    /**
 * Get dataset dependencies 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.batchGetSecurityMonitoringDatasetDependencies"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

const params: v2.SecurityMonitoringApiBatchGetSecurityMonitoringDatasetDependenciesRequest =
  {
    body: {
      data: {
        attributes: {
          datasetIds: ["123e4567-e89b-12d3-a456-426614174000"],
        },
      },
    },
  };

apiInstance
  .batchGetSecurityMonitoringDatasetDependencies(params)
  .then((data: v2.SecurityMonitoringDatasetDependenciesResponse) => {
    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"