POST /api/fleet/agents/actions/{actionId}/cancel
Api key auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Cancel a pending action for a specific agent.

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

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • actionId string Required
application/json

Body

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • ack_data Required
      • agents array[string]

        Not more than 10000 elements.

      • created_at string Required
      • data Required
      • expiration string
      • id string Required
      • minimum_execution_duration number
      • namespaces array[string]

        Not more than 100 elements.

      • rollout_duration_seconds number
      • sent_at string
      • source_uri string
      • start_time string
      • total number
      • type string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/agents/actions/{actionId}/cancel 
curl \
 --request POST 'https://<KIBANA_URL>/api/fleet/agents/actions/{actionId}/cancel' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"description":"Cancel an agent action","value":{}}'
Request example
Cancel an agent action 
{
  "description": "Cancel an agent action",
  "value": {}
}
Response examples (200)
Cancellation action created 
{
  "item": {
    "agents": [
      "agent-id-1"
    ],
    "created_at": "2024-01-01T00:00:00.000Z",
    "id": "cancel-action-id-1",
    "type": "CANCEL"
  }
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}