Query parameters

• agentPolicyId string

  An agent policy ID to scope the enrollment settings to. For example, that policy's Fleet Server host, its proxy, download location, etc. If not provided, the default Fleet Server policy is used (if any).

Responses

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

  OK

  Hide response attributes Show response attributes object

  • download_source object
    Hide download_source attributes Show download_source attributes object

    • host string Required
    • id string
    • is_default boolean Required
    • name string Required
    • proxy_id string | null

      The ID of the proxy to use for this download source. See the proxies API for more information.

  • fleet_server object Required
    Hide fleet_server attributes Show fleet_server attributes object

    • has_active boolean Required
    • host object
      Hide host attributes Show host attributes object

      • host_urls array[string] Required
      • id string Required
      • is_default boolean Required
      • is_internal boolean
      • is_preconfigured boolean Required
      • name string
      • proxy_id string
    • host_proxy object
      Hide host_proxy attributes Show host_proxy attributes object

      • certificate string
      • certificate_authorities string
      • certificate_key string
      • id string
      • name string Required
      • proxy_headers object
      • url string Required
    • policies array[object]
      Hide policies attributes Show policies attributes object

      • download_source_id string
      • fleet_server_host_id string
      • has_fleet_server boolean
      • id string Required
      • is_default_fleet_server boolean
      • is_managed boolean Required
      • name string Required
• 400 application/json; Elastic-Api-Version=2023-10-31

  Generic Error

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number