Finalize detection alert migrations Deprecated

View as Markdown
POST /api/detection_engine/signals/finalize_migration
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/detection_engine/signals/finalize_migration

Refer to Spaces for more information.

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

Body Required

Array of migration_ids to finalize

  • migration_ids array[string] Required

    At least 1 element.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • completed boolean Required
    • destinationIndex string Required
    • error object
      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

    Invalid input data response

    One of:
    Security_Detections_API_PlatformErrorResponse object Security_Detections_API_SiemErrorResponse object
  • 401 application/json

    Unsuccessful authentication response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 500 application/json

    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 \
 --request POST 'https://localhost:5601/api/detection_engine/signals/finalize_migration' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"migration_ids":["string"]}'