API Stability Short-Term

The updateLogCollectorGroupFilter() GraphQL mutation is used to update Log Collector's group filter.

Syntax

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

graphql
updateLogCollectorGroupFilter(
      id: string!, 
      filter: string
   ): LogCollectorGroup!

There are no special given datatypes for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  updateLogCollectorGroupFilter( 
     id: "abc123",
     filter: "#vhost"
  )
 { 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 {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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 {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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 { ^
  updateLogCollectorGroupFilter(  ^
     id: \"abc123\", ^
     filter: \"#vhost\" ^
  ) ^
 { name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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 {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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 {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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 {
  updateLogCollectorGroupFilter( 
     id: \"abc123\",
     filter: \"#vhost\"
  )
 { 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": {
    "updateLogCollectorGroupFilter": {
      "name": "we-few"
    }
  }
}

Returned Datatypes

For LogCollectorGroup, there are several parameters. Below is a list of them along with a description of each:

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.