Finalize detection alert migrations

POST /api/detection_engine/signals/finalize_migration

Finalize successful migrations of detection alerts. This replaces the original index's alias with the successfully migrated index's alias. The endpoint is idempotent; therefore, it can safely be used to poll a given migration and, upon completion, finalize it.

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

Body Required

Array of migration_ids to finalize

migration_ids array[string] Required

At least 1 element.

Responses

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

Successful response
Hide response attributes Show response attributes object
- completed boolean Required
- destinationIndex string Required
- error object
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  message string Required
  
  status_code integer Required
- id string Required
- sourceIndex string Required
- status string Required
  
  Values are success, failure, or pending.
- updated string(date-time) Required
- version 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/finalize_migration

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

Request examples

{
  "migration_ids": [
    "string"
  ]
}

Response examples (200)

[
  {
    "completed": true,
    "destinationIndex": "string",
    "error": {
      "message": "string",
      "status_code": 42
    },
    "id": "string",
    "sourceIndex": "string",
    "status": "success",
    "updated": "2024-05-04T09:42:00+00:00",
    "version": "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
}