GET /api/fleet/fleet_server_hosts
Api key auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/fleet_server_hosts

Refer to Spaces for more information.

List all Fleet Server hosts.

[Required authorization] Route required privileges: fleet-agents-all OR fleet-settings-read.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • items array[object] Required

      Not more than 10000 elements.

      Hide items attributes Show items attributes object
      • host_urls array[string] Required

        At least 1 but not more than 10 elements.

      • id string Required
      • is_default boolean

        Default value is false.

      • is_internal boolean
      • is_preconfigured boolean

        Default value is false.

      • name string Required
      • proxy_id string | null
      • secrets object

        Additional properties are NOT allowed.

        Hide secrets attribute Show secrets attribute object
      • ssl object | null

        Additional properties are NOT allowed.

        Hide ssl attributes Show ssl attributes object | null
        • agent_certificate string
        • agent_certificate_authorities array[string]

          Not more than 10 elements.

        • agent_key string
        • certificate string
        • certificate_authorities array[string]

          Not more than 10 elements.

        • client_auth string

          Values are optional, required, or none.

        • es_certificate string
        • es_certificate_authorities array[string]

          Not more than 10 elements.

        • es_key string
        • key string
    • page number Required
    • perPage number Required
    • total number Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/fleet_server_hosts 
curl \
 --request GET 'https://<KIBANA_URL>/api/fleet/fleet_server_hosts' \
 --header "Authorization: $API_KEY"
Response examples (200)
List of Fleet Server hosts 
{
  "items": [
    {
      "host_urls": [
        "https://fleet-server.example.com:8220"
      ],
      "id": "fleet-server-host-id-1",
      "is_default": true,
      "is_preconfigured": false,
      "name": "Default Fleet Server"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 1
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}