Delete an agent policy

Base URL: https://{kibana_url}

POST /api/fleet/agent_policies/delete

Auth

Delete an agent policy by ID.

Required privileges

Privileges fleet-agent-policies-all

Header parameters

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

Request body

agentPolicyId string required: The ID of the agent policy
force boolean: bypass validation checks that can prevent agent policy deletion

Responses

Successful response

application/json

id string required
name string required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Delete an agent policy by ID

Console Kibana Dev Tools

POST kbn:/api/fleet/agent_policies/delete
{
  "agentPolicyId": "agent-policy-id-1"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agent_policies/delete" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agentPolicyId": "agent-policy-id-1"
  }'

Generated from the API spec

Response

The agent policy was successfully deleted

{
  "id": "agent-policy-id-1",
  "name": "My agent policy"
}

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

Required privileges

Header parameters

Request body { }

Responses

Request body