Delete agent policy by ID

POST /api/fleet/agent_policies/delete

Headers

kbn-xsrf string Required

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

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

Body

agentPolicyId string Required
force boolean

bypass validation checks that can prevent agent policy deletion

Responses

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

OK
Hide response attributes Show response attributes object
- id string Required
- success boolean Required
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/agent_policies/delete

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

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "agentPolicyId": "string",
  "force": true
}

Response examples (200)

{
  "id": "string",
  "success": true
}

Response examples (400)

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