{ "opencollection": "1.0.0", "info": { "name": "Kibana APIs Actions Elastic Agent actions API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Elastic Agent actions", "type": "folder" }, "items": [ { "info": { "name": "Create an agent action", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/actions", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/actions
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nCreate a new action for a specific agent.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Reassign an agent", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/reassign", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/reassign
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nReassign an agent to a different agent policy.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Request agent diagnostics", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/request_diagnostics", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/request_diagnostics
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRequest a diagnostics bundle from a specific agent.

[Required authorization] Route required privileges: fleet-agents-read." }, { "info": { "name": "Rollback an agent", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/rollback", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID to rollback" } ] }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/rollback
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRollback an agent to the previous version.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Unenroll an agent", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/unenroll", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/unenroll
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUnenroll a specific agent, optionally revoking its enrollment API key.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Upgrade an agent", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/:agentId/upgrade", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/{agentId}/upgrade
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpgrade a specific agent to a newer version.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Get an agent action status", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/fleet/agents/action_status", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "date", "value": "", "type": "query", "description": "Return actions created before this date" }, { "name": "latest", "value": "", "type": "query", "description": "Return only the latest N actions" }, { "name": "errorSize", "value": "", "type": "query", "description": "Number of error details to include per action" } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/fleet/agents/action_status
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nGet the current status of recent agent actions.

[Required authorization] Route required privileges: fleet-agents-read." }, { "info": { "name": "Cancel an agent action", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/actions/:actionId/cancel", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "actionId", "value": "", "type": "path", "description": "The ID of the action to cancel" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/actions/{actionId}/cancel
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nCancel a pending action for a specific agent.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Bulk reassign agents", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_reassign", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_reassign
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nReassign multiple agents to a different agent policy.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Bulk request diagnostics from agents", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_request_diagnostics", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_request_diagnostics
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRequest diagnostics bundles from multiple agents.

[Required authorization] Route required privileges: fleet-agents-read." }, { "info": { "name": "Bulk rollback agents", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_rollback", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_rollback
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRollback multiple agents to the previous version.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Bulk unenroll agents", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_unenroll", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_unenroll
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUnenroll multiple agents, optionally revoking their enrollment API keys.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Bulk update agent tags", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_update_agent_tags", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_update_agent_tags
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nAdd or remove tags across multiple agents.

[Required authorization] Route required privileges: fleet-agents-all." }, { "info": { "name": "Bulk upgrade agents", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/agents/bulk_upgrade", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/agents/bulk_upgrade
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpgrade multiple agents to a newer version, with optional rollout controls.

[Required authorization] Route required privileges: fleet-agents-all." } ] } ], "bundled": true }