Get dataset dependencies

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.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
    # 
    
    # 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.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 "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "datasetIds": [ "123e4567-e89b-12d3-a456-426614174000" ] } } } EOF