Summary

The setWantedLogCollectorVersion() GraphQL mutation is used to set the wanted version of Log Collector.

API Stability Short-Term

Syntax

graphql
setWantedLogCollectorVersion(
      id: string!, 
      version: string, 
      timeOfUpdate: datetime
   ): boolean

For this mutation, you'll have to give the unique identifier of the LogCollector. You may also give the version and the time of the update. Click on the Show Query link above for an example of how to get the identifier and related settings.

No return value needs to be specified. A value of true will be returned if successful.

Example

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

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 {
  setWantedLogCollectorVersion( 
     id: \"abc123\",
     version: \"1.3.0\",
  ) 
}"
}
);


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
{
  "setWantedLogCollectorVersion": true
  }
}

Input Parameters

For the input, you'll have to give the unique identifier of the LogCollector. You may also give the version and the time of the update. Click on the Show Query link above the Syntax section for an example of how to get the identifier and related settings.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
id string yes   The unique identifier of the LogCollector installation.
timeOfUpdate datetime     The date and time of the update.
version string     The LogCollector version.