API Stability Short-Term

The searchLogCollectorGroups() GraphQL query will search log collector configurations. This is a preview and subject to change.

Syntax

Below is the syntax for the searchLogCollectorGroups() query field:

graphql
searchLogCollectorGroups(
      searchFilter: string, skip: integer, limit: integer, 
      sortBy: FleetGroups__SortBy, orderBy: OrderBy
   ): SearchLogCollectorGroupsResultSet!

Below is an example using this query field:

Show:
graphql
query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}

Returned Datatype

For SearchLogCollectorGroupsResultSet, there are a couple of parameters. They're listed here:

Table: SearchLogCollectorGroupsResultSet

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
results[LogCollectorGroup]yes Short-TermThe paginated result set. See LogCollectorGroup.
totalResultsintegeryes Short-TermThe total number of matching results.