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 Agents API

Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.

Kibana Elastic Agents 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 Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

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

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

18 operations 14 paths 0 schemas 2 DELETE9 GET6 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 Agents 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 18

Across 14 paths, the API surfaces 18 operations — 2 DELETE, 9 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Elastic Agents 18

Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.

GET
/api/fleet/agent_status/data
Get incoming agent data
get-fleet-agent-status-data 4 params → 200400
GET
/api/fleet/agents
Get agents
get-fleet-agents 14 params → 200400
POST
/api/fleet/agents
Get agents by action ids
post-fleet-agents 1 param body → 200400
DELETE
/api/fleet/agents/{agentId}
Delete an agent
delete-fleet-agents-agentid 2 params → 200400404
GET
/api/fleet/agents/{agentId}
Get an agent
get-fleet-agents-agentid 2 params → 200400404
PUT
/api/fleet/agents/{agentId}
Update an agent by ID
put-fleet-agents-agentid 2 params body → 200400404
GET
/api/fleet/agents/{agentId}/effective_config
Get an agent's effective config
get-fleet-agents-agentid-effective-config 1 param → 200400
POST
/api/fleet/agents/{agentId}/migrate
Migrate a single agent
post-fleet-agents-agentid-migrate 2 params body → 200400
POST
/api/fleet/agents/{agentId}/privilege_level_change
Change agent privilege level
post-fleet-agents-agentid-privilege-level-change 2 params body → 200400
GET
/api/fleet/agents/{agentId}/uploads
Get agent uploads
get-fleet-agents-agentid-uploads 1 param → 200400
GET
/api/fleet/agents/available_versions
Get available agent versions
get-fleet-agents-available-versions → 200400
POST
/api/fleet/agents/bulk_migrate
Migrate multiple agents
post-fleet-agents-bulk-migrate 1 param body → 200400
POST
/api/fleet/agents/bulk_privilege_level_change
Bulk change agent privilege level
post-fleet-agents-bulk-privilege-level-change 1 param body → 200400
DELETE
/api/fleet/agents/files/{fileId}
Delete an uploaded file
delete-fleet-agents-files-fileid 2 params → 200400
GET
/api/fleet/agents/files/{fileId}/{fileName}
Get an uploaded file
get-fleet-agents-files-fileid-filename 2 params → 200400
GET
/api/fleet/agents/setup
Get agent setup info
get-fleet-agents-setup → 200400
POST
/api/fleet/agents/setup
Initiate Fleet setup
post-fleet-agents-setup 1 param → 200400
GET
/api/fleet/agents/tags
Get agent tags
get-fleet-agents-tags 2 params → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-elastic-agents-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