Bulk remove OpAMP collectors

Base URL: https://{kibana_url}

POST /api/fleet/agents/bulk_remove_collectors
POST /s/{space_id}/api/fleet/agents/bulk_remove_collectors

Refer to Spaces for more information.

Remove multiple OpAMP collectors from the Fleet agents list. Marks the collectors as unenrolled. This action does not invalidate API keys, so collectors can reconnect on their 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>

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Remove multiple OpAMP collectors

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_remove_collectors
{
  "agents": [
    "collector-id-1",
    "collector-id-2"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_remove_collectors" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": [
      "collector-id-1",
      "collector-id-2"
    ]
  }'

Generated from the API spec

Response

Bulk remove collectors action result

{
  "actionId": "action-id-1"
}

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

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body