🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The searchLogCollectorConfigurations() GraphQL query searches LogCollector configurations.

Syntax

graphql
searchLogCollectorConfigurations(
      searchFilter: String,
      skip: Int = 0,
      limit: Int = 50,
      sortBy: FleetConfiguration__SortBy = Name,
      orderBy: OrderBy = ASC
   ): SearchLogCollectorConfigurationResultSet!

Provide 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.

Returns a non-nullable SearchLogCollectorConfigurationResultSet object. See the Returned Values section.

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

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 Int   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 Int   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.

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

Returned Values

Returns a non-nullable SearchLogCollectorConfigurationResultSet object. The table below lists all fields:

Table: SearchLogCollectorConfigurationResultSet Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
resultsLogCollectorConfigurationyes Short-Term The paginated result set See LogCollectorConfiguration.
totalResultsIntyes Short-Term The total number of matching results.

The SearchLogCollectorConfigurationResultSet type contains LogCollectorConfiguration objects. For reference, the LogCollectorConfiguration datatype table is included here:

Table: LogCollectorConfiguration Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
descriptionString  Short-Term A description of the Log Collector configuration.
draftString  Short-Term The configuration draft.
draftModifiedAtDateTime  Short-Term The date and time of the last draft of the configuration.
idStringyes Short-Term The unique identifier for the log collector configuration.
instancesIntyes Short-Term The number of instances.
isTestRunningBooleanyes Short-Term Whether a test is running.
modifiedAtDateTimeyes Short-Term The date and time of the current configuration.
modifiedByStringyes Short-Term Who last modified the configuration.
nameStringyes Short-Term The name assigned to the log collector configuration.
versionIntyes Short-Term The version used.
yamlString  Short-Term Configuration in YAML format.
yamlCharactersCountIntyes Short-Term The yaml character count.