Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana Elastic Agent policies API

Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and auto-upgrade status information.

Kibana Elastic Agent policies API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Elastic Agent policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 14 operations across 12 paths. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

14 operations 12 paths 0 schemas 8 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana Elastic Agent policies API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 8 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Elastic Agent policies 14

Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and a…

GET
/api/fleet/agent_policies
Get agent policies
get-fleet-agent-policies 10 params → 200400
POST
/api/fleet/agent_policies
Create an agent policy
post-fleet-agent-policies 2 params body → 200400
POST
/api/fleet/agent_policies/_bulk_get
Bulk get agent policies
post-fleet-agent-policies-bulk-get 2 params body → 200400404
GET
/api/fleet/agent_policies/{agentPolicyId}
Get an agent policy
get-fleet-agent-policies-agentpolicyid 2 params → 200400404
PUT
/api/fleet/agent_policies/{agentPolicyId}
Update an agent policy
put-fleet-agent-policies-agentpolicyid 3 params body → 200400
GET
/api/fleet/agent_policies/{agentPolicyId}/auto_upgrade_agents_status
Get auto upgrade agent status
get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status 1 param → 200400
POST
/api/fleet/agent_policies/{agentPolicyId}/copy
Copy an agent policy
post-fleet-agent-policies-agentpolicyid-copy 3 params body → 200400
GET
/api/fleet/agent_policies/{agentPolicyId}/download
Download an agent policy
get-fleet-agent-policies-agentpolicyid-download 5 params → 200400404
GET
/api/fleet/agent_policies/{agentPolicyId}/full
Get a full agent policy
get-fleet-agent-policies-agentpolicyid-full 5 params → 200400404
GET
/api/fleet/agent_policies/{agentPolicyId}/outputs
Get outputs for an agent policy
get-fleet-agent-policies-agentpolicyid-outputs 1 param → 200400404
POST
/api/fleet/agent_policies/delete
Delete an agent policy
post-fleet-agent-policies-delete 1 param body → 200400
POST
/api/fleet/agent_policies/outputs
Get outputs for agent policies
post-fleet-agent-policies-outputs 1 param body → 200400
GET
/api/fleet/kubernetes
Get a full K8s agent manifest
get-fleet-kubernetes 3 params → 200400
GET
/api/fleet/kubernetes/download
Download an agent manifest
get-fleet-kubernetes-download 3 params → 200400404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-elastic-agent-policies-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API