Elastic Agent policies

Get agent policies

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/fleet/agent_policies</span></div>

Refer to Spaces for more information.

List all agent policies.<br/><br/>[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup.

get/api/fleet/agent_policies

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/fleet/agent_policies
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

pagenumber

Page number

perPagenumber

Number of results per page

sortFieldstring

Field to sort results by

sortOrder'desc' | 'asc'

Sort order, ascending or descending

showUpgradeableboolean

When true, only show policies with upgradeable agents

kuerystring

A KQL query string to filter results

showAgentlessboolean

When false, exclude managed integration policies from the results. To manage these policies, use the managed integrations APIs.

noAgentCountboolean

use withAgentCount instead

withAgentCountboolean

get policies with agent count

fullboolean

get full policies with package policies populated

format'simplified' | 'legacy'

Format for the response: simplified or legacy

Response

Successful response

pagenumber required
perPagenumber required
totalnumber required

Changes

  • 18986b50fb8eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      response property items/items/download_source_id deprecated