For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/security-monitoring/bulk-subscribe-to-sample-log-generation.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

Bulk subscribe to sample log generation

copy 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/sample_log_generation/subscriptions/bulkhttps://api.ap2.datadoghq.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.datadoghq.eu/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.ddog-gov.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.us2.ddog-gov.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.uk1.datadoghq.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.datadoghq.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.us3.datadoghq.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulkhttps://api.us5.datadoghq.com/api/v2/security_monitoring/sample_log_generation/subscriptions/bulk

Overview

Subscribe to sample log generation for multiple Cloud SIEM content packs in a single call. Each requested content pack is processed independently; the response includes a per-item status so partial successes can be inspected.

Availability: this endpoint is restricted to Cloud SIEM trial organizations on an eligible pricing model. Non-trial orgs receive 403 Forbidden, the feature flag may also reject requests with 400 Bad Request, and legacy pricing tiers receive per-item responses with status: not_available.

This endpoint requires any of the following permissions:
  • security_monitoring_filters_write
  • logs_modify_indexes

    • OAuth apps require the security_monitoring_filters_write, logs_modify_indexes authorization scope to access this endpoint.

    Request

    Body Data (required)

    The content packs to subscribe to and the desired duration of the subscriptions.

    Expand All

    Field

    Type

    Description

    data [required]

    object

    The bulk subscription request body.

    attributes [required]

    object

    The attributes for creating sample log generation subscriptions for multiple content packs.

    content_pack_ids [required]

    [string]

    The identifiers of the Cloud SIEM content packs to subscribe to. At most five content packs can be requested in a single call.

    duration

    enum

    How long the subscription should remain active before expiring. Allowed enum values: 1h,1d,3d,7d

    default: 3d

    type [required]

    enum

    The type of the resource. The value should always be bulk_subscription_requests. Allowed enum values: bulk_subscription_requests

    default: bulk_subscription_requests

    {
  "data": {
    "attributes": {
      "content_pack_ids": [
        "aws-cloudtrail"
      ],
      "duration": "3d"
    },
    "type": "bulk_subscription_requests"
  }
}

    Response

    OK

    Response containing the per-content-pack results of a bulk subscription request.

    Expand All

    Field

    Type

    Description

    data [required]

    [object]

    The list of bulk subscription results, one per requested content pack.

    attributes [required]

    object

    The attributes describing a sample log generation subscription.

    content_pack_id [required]

    string

    The identifier of the Cloud SIEM content pack the subscription targets.

    created_at [required]

    date-time

    The time at which the subscription was created.

    expires_at [required]

    date-time

    The time at which the subscription expires and stops generating logs.

    is_active [required]

    boolean

    Whether the subscription is currently active and generating logs.

    status [required]

    enum

    The status of the subscription. Allowed enum values: subscribed,renewed,unsubscribed,no_active_subscription,not_available,active,expired

    id [required]

    string

    The unique identifier of the subscription, when one was created.

    meta [required]

    object

    Per-item status returned for a bulk subscription request.

    error

    string

    A description of the error encountered for this content pack, if the subscription could not be created.

    status [required]

    int32

    The HTTP status code that resulted from creating the subscription for this content pack.

    type [required]

    enum

    The type of the resource. The value should always be subscriptions. Allowed enum values: subscriptions

    default: subscriptions

    {
  "data": [
    {
      "attributes": {
        "content_pack_id": "aws-cloudtrail",
        "created_at": "2026-05-08T20:02:13.77481Z",
        "expires_at": "2026-05-11T20:02:13.77481Z",
        "is_active": true,
        "status": "subscribed"
      },
      "id": "123",
      "meta": {
        "error": "content pack does not exist",
        "status": 200
      },
      "type": "subscriptions"
    }
  ]
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Not Authorized

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "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/sample_log_generation/subscriptions/bulk" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "content_pack_ids": [
        "aws-cloudtrail"
      ],
      "duration": "3d"
    },
    "type": "bulk_subscription_requests"
  }
}
EOF
    
                
    """
Bulk subscribe to sample log generation 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.sample_log_generation_bulk_subscription_attributes import (
    SampleLogGenerationBulkSubscriptionAttributes,
)
from datadog_api_client.v2.model.sample_log_generation_bulk_subscription_data import (
    SampleLogGenerationBulkSubscriptionData,
)
from datadog_api_client.v2.model.sample_log_generation_bulk_subscription_request import (
    SampleLogGenerationBulkSubscriptionRequest,
)
from datadog_api_client.v2.model.sample_log_generation_bulk_subscription_request_type import (
    SampleLogGenerationBulkSubscriptionRequestType,
)
from datadog_api_client.v2.model.sample_log_generation_duration import SampleLogGenerationDuration

body = SampleLogGenerationBulkSubscriptionRequest(
    data=SampleLogGenerationBulkSubscriptionData(
        attributes=SampleLogGenerationBulkSubscriptionAttributes(
            content_pack_ids=[
                "aws-cloudtrail",
            ],
            duration=SampleLogGenerationDuration.THREE_DAYS,
        ),
        type=SampleLogGenerationBulkSubscriptionRequestType.BULK_SUBSCRIPTION_REQUESTS,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["bulk_create_sample_log_generation_subscriptions"] = True
with ApiClient(configuration) as api_client:
    api_instance = SecurityMonitoringApi(api_client)
    response = api_instance.bulk_create_sample_log_generation_subscriptions(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"
    # Bulk subscribe to sample log generation returns "OK" response

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

body = DatadogAPIClient::V2::SampleLogGenerationBulkSubscriptionRequest.new({
  data: DatadogAPIClient::V2::SampleLogGenerationBulkSubscriptionData.new({
    attributes: DatadogAPIClient::V2::SampleLogGenerationBulkSubscriptionAttributes.new({
      content_pack_ids: [
        "aws-cloudtrail",
      ],
      duration: DatadogAPIClient::V2::SampleLogGenerationDuration::THREE_DAYS,
    }),
    type: DatadogAPIClient::V2::SampleLogGenerationBulkSubscriptionRequestType::BULK_SUBSCRIPTION_REQUESTS,
  }),
})
p api_instance.bulk_create_sample_log_generation_subscriptions(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"
    // Bulk subscribe to sample log generation 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.SampleLogGenerationBulkSubscriptionRequest{
		Data: datadogV2.SampleLogGenerationBulkSubscriptionData{
			Attributes: datadogV2.SampleLogGenerationBulkSubscriptionAttributes{
				ContentPackIds: []string{
					"aws-cloudtrail",
				},
				Duration: datadogV2.SAMPLELOGGENERATIONDURATION_THREE_DAYS.Ptr(),
			},
			Type: datadogV2.SAMPLELOGGENERATIONBULKSUBSCRIPTIONREQUESTTYPE_BULK_SUBSCRIPTION_REQUESTS,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.BulkCreateSampleLogGenerationSubscriptions", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewSecurityMonitoringApi(apiClient)
	resp, r, err := api.BulkCreateSampleLogGenerationSubscriptions(ctx, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.BulkCreateSampleLogGenerationSubscriptions`:\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"
    // Bulk subscribe to sample log generation 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.SampleLogGenerationBulkSubscriptionAttributes;
import com.datadog.api.client.v2.model.SampleLogGenerationBulkSubscriptionData;
import com.datadog.api.client.v2.model.SampleLogGenerationBulkSubscriptionRequest;
import com.datadog.api.client.v2.model.SampleLogGenerationBulkSubscriptionRequestType;
import com.datadog.api.client.v2.model.SampleLogGenerationBulkSubscriptionResponse;
import com.datadog.api.client.v2.model.SampleLogGenerationDuration;
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.bulkCreateSampleLogGenerationSubscriptions", true);
    SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

    SampleLogGenerationBulkSubscriptionRequest body =
        new SampleLogGenerationBulkSubscriptionRequest()
            .data(
                new SampleLogGenerationBulkSubscriptionData()
                    .attributes(
                        new SampleLogGenerationBulkSubscriptionAttributes()
                            .contentPackIds(Collections.singletonList("aws-cloudtrail"))
                            .duration(SampleLogGenerationDuration.THREE_DAYS))
                    .type(
                        SampleLogGenerationBulkSubscriptionRequestType.BULK_SUBSCRIPTION_REQUESTS));

    try {
      SampleLogGenerationBulkSubscriptionResponse result =
          apiInstance.bulkCreateSampleLogGenerationSubscriptions(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling"
              + " SecurityMonitoringApi#bulkCreateSampleLogGenerationSubscriptions");
      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"
    // Bulk subscribe to sample log generation returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
use datadog_api_client::datadogV2::model::SampleLogGenerationBulkSubscriptionAttributes;
use datadog_api_client::datadogV2::model::SampleLogGenerationBulkSubscriptionData;
use datadog_api_client::datadogV2::model::SampleLogGenerationBulkSubscriptionRequest;
use datadog_api_client::datadogV2::model::SampleLogGenerationBulkSubscriptionRequestType;
use datadog_api_client::datadogV2::model::SampleLogGenerationDuration;

#[tokio::main]
async fn main() {
    let body = SampleLogGenerationBulkSubscriptionRequest::new(
        SampleLogGenerationBulkSubscriptionData::new(
            SampleLogGenerationBulkSubscriptionAttributes::new(vec!["aws-cloudtrail".to_string()])
                .duration(SampleLogGenerationDuration::THREE_DAYS),
            SampleLogGenerationBulkSubscriptionRequestType::BULK_SUBSCRIPTION_REQUESTS,
        ),
    );
    let mut configuration = datadog::Configuration::new();
    configuration
        .set_unstable_operation_enabled("v2.bulk_create_sample_log_generation_subscriptions", true);
    let api = SecurityMonitoringAPI::with_config(configuration);
    let resp = api
        .bulk_create_sample_log_generation_subscriptions(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
    /**
 * Bulk subscribe to sample log generation 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.bulkCreateSampleLogGenerationSubscriptions"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

const params: v2.SecurityMonitoringApiBulkCreateSampleLogGenerationSubscriptionsRequest =
  {
    body: {
      data: {
        attributes: {
          contentPackIds: ["aws-cloudtrail"],
          duration: "3d",
        },
        type: "bulk_subscription_requests",
      },
    },
  };

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