Get a metadata list

Base URL: https://{kibana_url}

GET /api/endpoint/metadata
GET /s/{space_id}/api/endpoint/metadata

Refer to Spaces for more information.

Get a list of all endpoint host metadata.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Response

Indicates a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/endpoint/metadata?hostStatuses=healthy&hostStatuses=updating

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/endpoint/metadata?hostStatuses=healthy&hostStatuses=updating" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "data": [
    {
      "host_status": "healthy",
      "last_checkin": "2023-07-04T15:47:57.432Z",
      "metadata": {
        "agent": {
          "id": "285297c6-3bff-4b83-9a07-f3e749801123",
          "type": "endpoint",
          "version": "8.10.0"
        },
        "Endpoint": {
          "policy": {
            "applied": {
              "id": "d5371dcd-93b7-4627-af88-4084f7d6aa3e",
              "name": "test",
              "status": "success"
            }
          },
          "status": "enrolled"
        },
        "host": {
          "hostname": "WinDev2104Eval",
          "os": {
            "name": "Windows",
            "platform": "windows",
            "version": "20H2"
          }
        }
      }
    }
  ],
  "page": 0,
  "pageSize": 10,
  "sortDirection": "desc",
  "sortField": "enrolled_at",
  "total": 1
}