Summary

The updateLogCollectorGroupName() GraphQL mutation is used to update Log Collector's group name.

API Stability Long-Term

Syntax

graphql
updateLogCollectorGroupName(
      id: string!, 
      name: string!
   ): LogCollectorGroup!

You'll have to give the unique identifier of the LogCollector group, and the new name for the group.

For the results, you can get the LogCollector configuration, any filters used, and other related data. See the Returned Values section for more.

Example

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

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 {
  updateLogCollectorGroupName( 
     id: \"abc123\",
     name: \"we-happy-few\"
  )
 { id }
}"
}
);


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": {
    "updateLogCollectorGroupName": {
      "id": "abc123"
    }
  }
}

Input Parameters

For the input, you would need to provide the unique identifier of the LogCollector group, and the new name for the group.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
id string yes   The unique identifier for the LogCollector group.
name string yes   The new name of the group.

Returned Values

For the results, you can get the LogCollector configuration, any filters used, and other related data. See the table below for details on the choices:

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