Initiate a detection alert migration

POST /api/detection_engine/signals/migration

Initiate a migration of detection alerts. Migrations are initiated per index. While the process is neither destructive nor interferes with existing data, it may be resource-intensive. As such, it is recommended that you plan your migrations accordingly.

application/json; Elastic-Api-Version=2023-10-31

Body Required

Alerts migration parameters

index array[string] Required

A string that is not empty and does not contain only whitespace

At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
requests_per_second integer

Minimum value is 1.
size integer

Minimum value is 1.
slices integer

Minimum value is 1.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Successful response
Hide response attribute Show response attribute object
- indices array[object] Required
  
  One of:
  Security_Detections_API_AlertsIndexMigrationSuccess object Security_Detections_API_AlertsIndexMigrationError object Security_Detections_API_SkippedAlertsIndexMigration object
  
  Hide attributes Show attributes
  
  error object Required
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  message string Required
  
  status_code string Required
  
  index string Required
400 application/json; Elastic-Api-Version=2023-10-31

Invalid input data response
One of:
Security_Detections_API_PlatformErrorResponse object Security_Detections_API_SiemErrorResponse object
Hide attributes Show attributes

error string Required

message string Required

statusCode integer Required
Hide attributes Show attributes

message string Required

status_code integer Required
401 application/json; Elastic-Api-Version=2023-10-31

Unsuccessful authentication response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
500 application/json; Elastic-Api-Version=2023-10-31

Internal server error response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required

POST /api/detection_engine/signals/migration

curl \
 -X POST https://localhost:5601/api/detection_engine/signals/migration \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "index": [
    "string"
  ],
  "requests_per_second": 42,
  "size": 42,
  "slices": 42
}

Response examples (200)

{
  "indices": [
    {
      "index": "string",
      "migration_id": "string",
      "migration_index": "string"
    }
  ]
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

{
  "message": "string",
  "status_code": 42
}

Response examples (401)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (500)

{
  "message": "string",
  "status_code": 42
}