Create agent action | Kibana API (v8)

Create agent action

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

Headers

kbn-xsrf string Required

Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Path parameters

agentId string Required

application/json; Elastic-Api-Version=2023-10-31

Body Required

action object
One of:
object-1 object object-2 object
Hide attributes Show attributes

ack_data string

data string

type string

Values are UNENROLL, UPGRADE, or POLICY_REASSIGN.
Hide attributes Show attributes

data object

Additional properties are allowed.

Hide data attribute Show data attribute object

log_level string | null

Values are debug, info, warning, or error.

type string

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attributes Show response attributes object
- body array[number]
- headers string
- statusCode number
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

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

curl \
 -X POST https://localhost:5601/api/fleet/agents/{agentId}/actions \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "action": {
    "ack_data": "string",
    "data": "string",
    "type": "UNENROLL"
  }
}

Response examples (200)

{
  "body": [
    42.0
  ],
  "headers": "string",
  "statusCode": 42.0
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}