Apply DataView indices to all installed engines

Base URL: https://{kibana_url}

POST /api/entity_store/engines/apply_dataview_indices
POST /s/{space_id}/api/entity_store/engines/apply_dataview_indices

Auth

Synchronize data view index patterns to all running entity engines so that newly added indices are picked up by the transforms.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Responses

Successful response

application/json

result object[]: Per-engine update results.
success boolean: Whether all engines updated successfully.

Partial successful response

application/json

errors string[]: Error messages for engines that failed to update.
result object[]: Per-engine update results for engines that succeeded.
success boolean: Always false for a partial success.

Error response

application/json

body string: Error message.
statusCode number: HTTP status code.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/entity_store/engines/apply_dataview_indices

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/entity_store/engines/apply_dataview_indices" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

All running engines were successfully updated with the current data view index patterns.

{
  "result": [
    {
      "changes": {
        "indexPatterns": [
          "logs-*",
          "filebeat-*",
          "auditbeat-*"
        ]
      },
      "type": "host"
    },
    {
      "changes": {
        "indexPatterns": [
          "logs-*",
          "filebeat-*",
          "auditbeat-*"
        ]
      },
      "type": "user"
    }
  ],
  "success": true
}

{
  "errors": [
    "Failed to update user engine: insufficient privileges"
  ],
  "result": [
    {
      "changes": {
        "indexPatterns": [
          "logs-*",
          "filebeat-*"
        ]
      },
      "type": "host"
    }
  ],
  "success": false
}

{
  "body": "An internal error occurred while updating engine indices",
  "statusCode": 500
}