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

Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bulk operations for agent lifecycle management.

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

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

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

14 operations 14 paths 0 schemas 1 GET13 POST

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 actions 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 14 paths, the API surfaces 14 operations — 1 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Elastic Agent actions 14

Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bul…

POST
/api/fleet/agents/{agentId}/actions
Create an agent action
post-fleet-agents-agentid-actions 2 params body → 200400
POST
/api/fleet/agents/{agentId}/reassign
Reassign an agent
post-fleet-agents-agentid-reassign 2 params body → 200400
POST
/api/fleet/agents/{agentId}/request_diagnostics
Request agent diagnostics
post-fleet-agents-agentid-request-diagnostics 2 params body → 200400
POST
/api/fleet/agents/{agentId}/rollback
Rollback an agent
post-fleet-agents-agentid-rollback 2 params → 200400
POST
/api/fleet/agents/{agentId}/unenroll
Unenroll an agent
post-fleet-agents-agentid-unenroll 2 params body → 200400
POST
/api/fleet/agents/{agentId}/upgrade
Upgrade an agent
post-fleet-agents-agentid-upgrade 2 params body → 200400
GET
/api/fleet/agents/action_status
Get an agent action status
get-fleet-agents-action-status 5 params → 200400
POST
/api/fleet/agents/actions/{actionId}/cancel
Cancel an agent action
post-fleet-agents-actions-actionid-cancel 2 params body → 200400
POST
/api/fleet/agents/bulk_reassign
Bulk reassign agents
post-fleet-agents-bulk-reassign 1 param body → 200400
POST
/api/fleet/agents/bulk_request_diagnostics
Bulk request diagnostics from agents
post-fleet-agents-bulk-request-diagnostics 1 param body → 200400
POST
/api/fleet/agents/bulk_rollback
Bulk rollback agents
post-fleet-agents-bulk-rollback 1 param body → 200400
POST
/api/fleet/agents/bulk_unenroll
Bulk unenroll agents
post-fleet-agents-bulk-unenroll 1 param body → 200400
POST
/api/fleet/agents/bulk_update_agent_tags
Bulk update agent tags
post-fleet-agents-bulk-update-agent-tags 1 param body → 200400
POST
/api/fleet/agents/bulk_upgrade
Bulk upgrade agents
post-fleet-agents-bulk-upgrade 1 param body → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-elastic-agent-actions-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