API Stability Short-Term

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

Syntax

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

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

For the input, there are several parameters. Some have default values: skip is 0; and limit is 50. There are defaults for the special datatypes. They're described in the Given Datatypes section below.

Below is an example using this query field:

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"
        }
      ]
    }
  }
}

Given Datatype

For FleetConfiguration__SortBy and OrderBy there are a few parameters. They're listed in the two tables here:

Table: FleetConfiguration__SortBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in 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.

Table: OrderBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in 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 Datatypes

The returned datatype SearchLogCollectorConfigurationResultSet has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SearchLogCollectorConfigurationResultSet

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in 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.