Delete an agent

Base URL: https://{kibana_url}

DELETE /api/fleet/agents/{agentId}
DELETE /s/{space_id}/api/fleet/agents/{agentId}

Refer to Spaces for more information.

Delete an agent by ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Responses

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn:/api/fleet/agents/AGENT_ID

Generated from the API spec

curl Shell

curl -X DELETE "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Agent successfully deleted

{
  "id": "agent-id-1",
  "success": true
}

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

{
  "error": "Not Found",
  "message": "Agent agent-id-1 not found",
  "statusCode": 404
}