Summary

The searchLogCollectorConfigurations() GraphQL query is used to search LogCollector configurations.

API Stability Short-Term

Syntax

graphql
searchLogCollectorConfigurations(
     searchFilter: string, 
     sortBy: FleetConfiguration__SortBy,
     orderBy: OrderBy,
     skip: integer,
     limit: integer
   ): SearchLogCollectorConfigurationResultSet!

For the input, you would give any text for searching Log Collector configurations, 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's configuration. See the Returned Values section further down this page.

Example

Raw
graphql
query {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}
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 {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}"
}
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 {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}"
}
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 { ^
  searchLogCollectorConfigurations( ^
     sortBy: Name, ^
     orderBy: DESC ^
  ) ^
  { totalResults,  ^
    results{ id, name, version, instances } ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}"
}'
    "$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 {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}";
$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 {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}"
}'''

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 {
  searchLogCollectorConfigurations(
     sortBy: Name,
     orderBy: DESC
  )
  { totalResults, 
    results{ id, name, version, instances }
  }
}"
}
);


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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "searchLogCollectorConfigurations": {
      "totalResults": 1,
      "results": [
        {
          "id": "abc123",
          "name": "our-config",
          "version": "1.234",
          "instances": "1"
        }
      ]
    }
  }
}

Input Parameters

For the input, you would provide any text on which to search for Log Collector configurations, 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 FleetConfiguration__SortBy     Basis for sorting results. See table below.

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

Table: FleetConfiguration__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 10, 2025
Instances   Short-TermUse to sort Fleet configurations by instances.
LastModified   Short-TermUse to sort by date last modified.
ModifiedBy   Short-TermUse to sort by user who last modified the configurations.
Name  ✓Short-TermSort by the name of the configurations.
Size   Short-TermSort by size.

The other input 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 the LogCollector's configuration.

Table: SearchLogCollectorConfigurationResultSet 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[LogCollectorConfiguration]yes Short-TermThe paginated result set See LogCollectorConfiguration.
totalResultsintegeryes Short-TermThe total number of matching results.

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

Table: LogCollectorConfiguration 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: Jun 26, 2025
descriptionstring  Short-TermA description of the Log Collector configuration.
draftstring  Short-TermThe configuration draft.
draftModifiedAtdatetime  Short-TermThe date and time of the last draft of the configuration.
idstringyes Short-TermThe unique identifier for the log collector configuration.
instancesintegeryes Short-TermThe number of instances.
isTestRunningbooleanyes Short-TermWhether a test is running.
modifiedAtdatetimeyes Short-TermThe date and time of the current configuration.
modifiedBystringyes Short-TermWho last modified the configuration.
namestringyes Short-TermThe name assigned to the log collector configuration.
versionintegeryes Short-TermThe version used.
yamlstring  Short-TermConfiguration in YAML format.
yamlCharactersCountintegeryes Short-TermThe yaml character count.