API Stability Short-Term

The createLogCollectorGroup() GraphQL mutation field is used to create a Log Collector group.

Syntax

Below is the syntax for the createLogCollectorGroup() mutation field:

graphql
createLogCollectorGroup(
       name: string!, 
       filter: string, 
       configIds: [string]
    ): LogCollectorGroup!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  createLogCollectorGroup(
         name: "my-lc-group" )
  { id, name }
}
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" : "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}"
}
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" : "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}"
}
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" : "mutation { ^
  createLogCollectorGroup( ^
         name: \"my-lc-group\" ) ^
  { id, name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}"
}'
    "$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 = "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}";
$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" : "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}"
}'''

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" : "mutation {
  createLogCollectorGroup(
         name: \"my-lc-group\" )
  { id, name }
}"
}
);


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": {
    "createLogCollectorGroup": {
      "id": "61ZbSM9Gh1TWiuVw1POrORr98X5EK5ny",
      "name": "my-lc-group"
    }
  }
}

Returned Datatypes

LogCollectorGroup has a few parameters. They're listed below:

Table: LogCollectorGroup

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