Get collector groups Experimental; added in 9.5.0

GET /api/fleet/agents/collector_groups
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/agents/collector_groups

Refer to Spaces for more information.

Get OpAMP collectors grouped by elastic.collector.group with cursor-based pagination.

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

Query parameters

  • groupBy string

    Field to group collectors by

    Values are collector.group or config.name. Default value is collector.group.

  • kuery string

    A KQL query string to filter collectors before grouping

    Maximum length is 4096.

  • perPage number

    Number of groups per page

    Minimum value is 1, maximum value is 1000. Default value is 20.

  • afterKey string

    After key is used for cursor-based pagination, use it to get the next page of results

    Maximum length is 2048.

  • showInactive boolean

    When true, include inactive collectors in the results

    Default value is false.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • afterKey string

      Maximum length is 2048.

    • items array[object] Required

      Not more than 1000 elements.

      Hide items attributes Show items attributes object
      • docCount number Required

        Number of collectors in this group

      • group string Required

        Group key value

        Maximum length is 1024.

      • groupDisplayName string Required

        Human-readable display name for the group

        Maximum length is 1024.

      • isUngrouped boolean

        True when the collectors in this bucket have no value for the group-by field

      • signals array[string] Required

        Signal types present in this group (for example, logs, metrics, traces)

        Not more than 10 elements. Maximum length of each is 64.
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/agents/collector_groups 
curl \
 --request GET 'https://localhost:5601/api/fleet/agents/collector_groups' \
 --header "Authorization: $API_KEY"
Response examples (200)
Collector groups 
{
  "afterKey": "{\"collector.group\":\"database-servers\"}",
  "items": [
    {
      "docCount": 5,
      "group": "web-servers",
      "groupDisplayName": "web-servers",
      "isUngrouped": false,
      "signals": [
        "logs",
        "metrics"
      ]
    },
    {
      "docCount": 3,
      "group": "database-servers",
      "groupDisplayName": "database-servers",
      "signals": [
        "metrics",
        "traces"
      ]
    }
  ]
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}