Remove an OpAMP collector

Base URL: https://{kibana_url}

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

Auth

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

Privileges fleet-agents-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
agentId string · min length: 0 required: The collector agent ID

Header parameters

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

Responses

200

Successful response

application/json

400

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/remove_collector

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Collector successfully removed

{}

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