API Stability Short-Term

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

Syntax

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

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

There are no special datatypes for this mutation field. Set id to the unique identifier of the LogCollector and version to the desired minimum version to use. Set timeOfUpdate to the date and time of the update.

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

Example

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

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
  }
}