Cancel an agent action

Server: https://{kibana_url}

POST /api/fleet/agents/actions/{actionId}/cancel
POST /s/{space_id}/api/fleet/agents/actions/{actionId}/cancel

Api key auth Basic auth

Refer to Spaces for more information.

Cancel a pending action for a specific agent.

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

Path Parameters

actionId string required: The ID of the action to cancel

Request

Responses

Successful response

application/json

Bad Request

application/json

Examples

Cancel an agent action

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/agents/actions/{actionId}/cancel
{}

curl Shell

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

Response

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

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