Get a full agent policy
Server:
https://{kibana_url}
- GET /api/fleet/agent_policies/{agentPolicyId}/full
- GET /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/full
Refer to Spaces for more information.
Get a full agent policy by ID.
[Required authorization] Route required privileges: fleet-agent-policies-read.
Path Parameters
-
agentPolicyIdstringrequired -
The ID of the agent policy
Query Parameters
-
downloadboolean If true, returns the policy as a downloadable file
-
standaloneboolean If true, returns the policy formatted for standalone agents
-
kubernetesboolean If true, returns the policy formatted for Kubernetes deployment
-
revisionnumber If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.
Responses
Successful response
-
itemanyOfrequired -
agentobject -
downloadobjectrequired -
authobject -
proxy_headersmap string to boolean | number | stringnullable -
proxy_urlstring -
sourceURIstringrequired -
sslobject -
certificatestring -
keystring -
renegotiationstring -
verification_modestring -
target_directorystring -
timeoutstring -
internalobjectrequired -
limitsobject -
go_max_procsnumber -
loggingobject -
monitoringobjectrequired -
_runtime_experimentalstring -
apmobjectrequired -
diagnosticsobject -
enabledbooleanrequired -
logsbooleanrequired -
metricsbooleanrequired -
namespacestring -
tracesbooleanrequired -
use_outputstring -
protectionobject -
enabledbooleanrequired -
signing_keystringrequired -
uninstall_token_hashstringrequired -
connectorsmap string to object -
exportersmap string to object -
extensionsmap string to object -
fleetanyOf -
hostsstring · max: 100required -
proxy_headersmap string to boolean | number | stringnullable -
proxy_urlstring -
sslobject -
certificatestring -
keystring -
renegotiationstring -
verification_modestring -
idstringrequired -
inputsobject · max: 10000required -
data_streamobjectrequired -
namespacestringrequired -
idstringrequired -
namestringrequired -
package_policy_idstringrequired -
processorsobject · max: 10000 -
add_fieldsobjectrequired -
revisionnumberrequired -
streamsobject · max: 10000 -
data_streamobjectrequired -
idstringrequired -
typestringrequired -
use_outputstringrequired -
namespacesstring · max: 100 -
output_permissionsmap string to string to object -
outputsmap string to objectrequired -
<string>object -
ca_sha256stringnullable -
hostsstring · max: 100 -
proxy_headersmap string to boolean | number | stringnullable -
proxy_urlstring -
typestringrequired -
processorsmap string to object -
receiversmap string to object -
revisionnumber -
secret_referencesobject · max: 10000 -
idstringrequired -
serviceobject -
extensionsstring · max: 1000 -
pipelinesmap string to object -
<string>object -
exportersstring · max: 1000 -
processorsstring · max: 1000 -
receiversstring · max: 1000
string
Bad Request
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber
404
application/json
Not Found