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

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

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

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
}