Create a Fleet Server host

POST /api/fleet/fleet_server_hosts
Api key auth

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

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • host_urls array[string] Required

    At least 1 element.

  • id string
  • 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]
    • agent_key string
    • certificate string
    • certificate_authorities array[string]
    • client_auth string

      Values are optional, required, or none.

    • es_certificate string
    • es_certificate_authorities array[string]
    • es_key string
    • key string

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

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

        At least 1 element.

      • 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]
        • agent_key string
        • certificate string
        • certificate_authorities array[string]
        • client_auth string

          Values are optional, required, or none.

        • es_certificate string
        • es_certificate_authorities array[string]
        • es_key string
        • key string
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/fleet_server_hosts 
curl \ --request POST 'https://<KIBANA_URL>/api/fleet/fleet_server_hosts' \ --header "Authorization: $API_KEY" \ --header "Content-Type: application/json" \ --header "kbn-xsrf: true" \ --data '{"host_urls":["string"],"id":"string","is_default":false,"is_internal":true,"is_preconfigured":false,"name":"string","proxy_id":"string","secrets":{"ssl":{"agent_key":{"id":"string"},"es_key":{"id":"string"},"key":{"id":"string"}}},"ssl":{"agent_certificate":"string","agent_certificate_authorities":["string"],"agent_key":"string","certificate":"string","certificate_authorities":["string"],"client_auth":"optional","es_certificate":"string","es_certificate_authorities":["string"],"es_key":"string","key":"string"}}'