Remove an OpAMP collector Experimental; added in 9.5.0

POST /api/fleet/agents/{agentId}/remove_collector
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/fleet/agents/{agentId}/remove_collector

Refer to Spaces for more information.

Remove a specific OpAMP collector from the Fleet agents list. Marks the collector as unenrolled. This action does not invalidate API keys, so the collector can reconnect on its own.

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

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • agentId string Required

    The collector agent ID

Responses

  • 200 application/json

    Successful response

  • 400 application/json

    Bad Request

POST /api/fleet/agents/{agentId}/remove_collector 
curl \
 --request POST 'https://localhost:5601/api/fleet/agents/{agentId}/remove_collector' \
 --header "Authorization: $API_KEY" \
 --header "kbn-xsrf: true"
Response examples (200)
Collector successfully removed 
{
  "description": "Collector successfully removed",
  "value": {}
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}