Cancel an agent action

Base URL: https://{kibana_url}

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

Auth

Cancel a pending action for a specific agent.

Required authorization

Privileges fleet-agents-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
actionId string required: The ID of the action to cancel

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

No schema is declared for this content type.

Responses

Successful response

application/json

item object required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Cancel an agent action

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/actions/ACTION_ID/cancel
{}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/actions/${ACTION_ID}/cancel" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

Cancellation action created

{
  "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
}