Get a metadata list

GET /api/endpoint/metadata

Query parameters

  • query object Required
    Hide query attributes Show query attributes object
    • hostStatuses array[string] Required

      Values are healthy, offline, updating, inactive, or unenrolled.

    • kuery string | null
    • page integer

      Page number

      Minimum value is 0. Default value is 0.

    • pageSize integer

      Number of items per page

      Minimum value is 1, maximum value is 10000. Default value is 10.

    • sortDirection string | null

      Values are asc or desc.

    • sortField string

      Values are enrolled_at, metadata.host.hostname, host_status, metadata.Endpoint.policy.applied.name, metadata.Endpoint.policy.applied.status, metadata.host.os.name, metadata.host.ip, metadata.agent.version, or last_checkin.

Responses

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

    OK
GET /api/endpoint/metadata 
curl \
 -X GET http://api.example.com/api/endpoint/metadata?query=%7B%7D
Response examples (200) 
{}