Create an agent action

Server: https://{kibana_url}

POST /api/fleet/agents/{agentId}/actions
POST /s/{space_id}/api/fleet/agents/{agentId}/actions

Api key auth

Refer to Spaces for more information.

Create a new action for a specific agent.

[Required authorization] Route required privileges: fleet-agents-all.

Path Parameters

agentId string required: The agent ID

Request

action union anyOf required: Any of:

Responses

Successful response

application/json

Bad Request

application/json

Examples

Create a UNENROLL action for an agent

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/agents/{agentId}/actions
{
  "action": {
    "type": "UNENROLL"
  }
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/agents/{agentId}/actions" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "action": {
    "type": "UNENROLL"
  }
}'

Response

{
  "item": {
    "agents": [
      "agent-id-1"
    ],
    "created_at": "2024-01-01T00:00:00.000Z",
    "id": "action-id-1",
    "type": "UNENROLL"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}