Version: SG FLX
Community
This is a Technical Preview and should not yet be used in production.
Policy Instance State
Content
Endpoint
GET /_aim/state/{index_name}
Retrieves the state of a managed index.
Path Parameters
| Parameter | Note |
|---|---|
index_name |
Name of the managed index |
Responses
200 OK
The requested index exists and is managed by AIM. The response body contains the state in JSON format.
403 Forbidden
The user does not have sufficient privileges to access this endpoint.
404 Not Found
The requested index does not exist or is not managed by AIM.
Privileges
The user needs to have the privilege cluster:admin:searchguard:aim:policy:instance:status/get to access this endpoint.
This permission is included in the following built-in action groups:
- SGS_AIM_ALL
- SGS_AIM_POLICY_INSTANCE_READ
- SGS_AIM_POLICY_INSTANCE_MANAGE