Security Monitoring

Update a batch migration

Update the name, description, or tags of a batch migration, in any status. At least one of these attributes must be provided. Omitted attributes are left unchanged, and tags replaces the full list of tags.

patch/api/v2/security_monitoring/batch-migrations/{batch_id}

Request

Base URL
https://api.datadoghq.com
Auth
- API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
- or OAuth 2
  Authorization code/oauth2/v1/authorize
  Token URL/oauth2/v1/token
  Scopessecurity_monitoring_rules_write
TypeScript
https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/security_monitoring/batch-migrations/:batch_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

batch_idstring uuid required

Example:7cdb3a75-64fb-46ce-9445-41969e78fe8e

The UUID of the batch migration.

Request body

Example request

{
  "data": {
    "attributes": {
      "description": "Rules imported from Splunk",
      "name": "Splunk migration - Windows",
      "tags": [
        "source:splunk"
      ]
    },
    "type": "batchMigration"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "createdAt": "2026-09-21T12:00:00Z",
      "createdBy": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
      "description": "Rules imported from Splunk",
      "inputSource": "batch_migration",
      "lastUpdatedAt": "2026-09-21T12:00:00Z",
      "lastUpdatedBy": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
      "name": "Splunk migration",
      "orgId": 123456,
      "resourceStatusCounts": {
        "pending": 1
      },
      "status": "draft",
      "tags": [
        "source:splunk"
      ]
    },
    "id": "7cdb3a75-64fb-46ce-9445-41969e78fe8e",
    "type": "batchMigration"
  }
}

Changes

Changes to this operation have not been checked yet.