Retrieve the status of detection alert migrations

POST /api/detection_engine/signals/migration_status

Retrieve indices that contain detection alerts of a particular age, along with migration information for each of those indices.

Query parameters

from string(date-math) Required

Maximum age of qualifying detection alerts

Responses

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

Successful response
Hide response attribute Show response attribute object
- indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  is_outdated boolean Required
  
  migrations array[object] Required
  
  Hide migrations attributes Show migrations attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  status string Required
  
  Values are success, failure, or pending.
  
  updated string(date-time) Required
  
  version integer Required
  
  signal_versions array[object] Required
  
  Hide signal_versions attributes Show signal_versions attributes object
  
  count integer Required
  
  version integer Required
  
  version integer 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_status

curl \
 -X POST https://localhost:5601/api/detection_engine/signals/migration_status?from=string

Response examples (200)

{
  "indices": [
    {
      "index": "string",
      "is_outdated": true,
      "migrations": [
        {
          "id": "string",
          "status": "success",
          "updated": "2024-05-04T09:42:00+00:00",
          "version": 42
        }
      ],
      "signal_versions": [
        {
          "count": 42,
          "version": 42
        }
      ],
      "version": 42
    }
  ]
}

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
}