Summary

The searchLogCollectorGroups() GraphQL query will search LogCollector configurations.

API Stability Short-Term

Syntax

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

For the input, you would give any text for searching Log Collector groups, how to sort and order them, and the number of results to skip and how many to return. See the Input Parameters section for more details.

For the results, you can get the total results found and the LogCollector configurations for the group. See the Returned Datatype section farther down this page.

Example

Raw
graphql
query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC) ^
     { totalResults,  ^
       results{id, name, collectorCount} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Input Parameters

For the input, you would provide any text on which to search for Log Collector groups, how to sort results (see the second table below), how to order results (see third), and the number of results to skip and how many to return.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this query. Since some of the parameters use special datatypes, additional tables for them are included below.
limit integer   50 The maximum number of results to return.
orderBy OrderBy   ASC How to order results. See table below.
searchFilter string     Any text on which to filter results.
skip integer   0 The number of results to skip, or offset to use.
sortBy FleetGroups__SortBy     The basis for sorting results. See table below.

For this special input datatype, you can specify how to sort Fleet groups.

Table: FleetGroups__SortBy Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 3, 2025
Collectors   Short-TermSort by Fleet groups by collectors.
Filter   Short-TermSort Fleet groups by filter.
Name  ✓Short-TermSort the groups by name.
WantedVersion   Short-TermUse this to sort by version of LogScale.

The other special datatype is a simple one. You can return results based on whether they are in ascending or descending order, alphanumerically.

Table: OrderBy Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 10, 2025
ASC  ✓Long-TermOrder results in ascending order (e.g., 0 to 9, A to Z).
DESC   Long-TermOrder results in descending order (e.g., 9 to 0, Z to A).

Returned Values

For the results, you can get the total results found, and through a sub-parameter, you can get the LogCollector configurations.

Table: SearchLogCollectorGroupsResultSet Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 3, 2024
results[LogCollectorGroup]yes Short-TermThe paginated result set. See LogCollectorGroup.
totalResultsintegeryes Short-TermThe total number of matching results.

The datatype above uses another datatype for information on Log Collector groups. For your convenience, the table for that sub-datatype is included here:

Table: LogCollectorGroup Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 26, 2024
collectorCountinteger   text
configurations[LogCollectorConfiguration]yes Short-TermThe log collector's configurations. See LogCollectorConfiguration.
filterstring  Short-TermThe filter used with the log collector.
idstringyes Short-TermThe unique identifier for the group.
namestringyes Short-TermThe name of the log collector group.
onlyUsesRemoteUpdatesbooleanyes Short-TermWhether the group only uses remove updates.
wantedVersionstring  Short-TermThe wanted version.