Clean up detection alert migrations

deprecated

Server: https://{kibana_url}

DELETE /api/detection_engine/signals/migration

DEPRECATED. Cleanup API for old migration artifacts. Do not add new call sites. WARNING: This schedules deletions; ensure no production reads still point at the source index.

Migrations favor data integrity over shard size. Consequently, unused or orphaned indices are artifacts of the migration process. A successful migration can leave both the old and new indices present, so the old index may be deleted. While you can delete these indices manually, the endpoint applies a deletion policy to the relevant index, causing it to be deleted after 30 days, and removes other migration-specific artifacts.

Request

Array of migration_ids to cleanup

migration_ids [] string · min: 1 required: Array of migration_ids to cleanup.

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE /api/detection_engine/signals/migration
{
  "migration_ids": [
    "924f7c50-505f-11eb-ae0a-3fa2e626a51d"
  ]
}

curl Shell

curl -X DELETE "https://{kibana_url}/api/detection_engine/signals/migration" \
  -H "Content-Type: application/json" \
  -d '{
  "migration_ids": [
    "924f7c50-505f-11eb-ae0a-3fa2e626a51d"
  ]
}'

Response

{
  "migrations": [
    {
      "destinationIndex": ".siem-signals-default-000002-r000016",
      "id": "924f7c50-505f-11eb-ae0a-3fa2e626a51d",
      "sourceIndex": ".siem-signals-default-000002",
      "status": "success",
      "updated": "2021-01-06T22:05:56.859Z",
      "version": 16
    }
  ]
}

{
  "error": "Bad Request",
  "message": "[request body].migration_ids: at least one migration id is required to run cleanup",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\n\tRoot causes:\n\t\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "message": "Internal Server Error",
  "status_code": 500
}