🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The updateLicenseKey() mutation installs a license key on a LogScale cluster. If the cluster already has a license, you need ManageCluster permission to replace it.

Syntax

graphql
updateLicenseKey(
      license: String!
   ): License!

The required license argument accepts the license key string to install on the cluster. The mutation returns a non-null License! object with details about the newly applied license.

Input parameters

This mutation requires a single input parameter. The following table describes it.

Table: Input parameters and datatypes

Parameter Type Required Default Description
This table lists all input parameters for this mutation.
license String yes   The license key string to install on the cluster.

Example

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

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 {
  updateLicenseKey( 
      license: \"abc123\"
  )
  { issuedAt }
}"
}
);


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": {
    "updateLicenseKey": {
      "issuedAt": "2024-07-18T12:48:27Z"
    }
  }
}

Returned values

The mutation returns a License! interface object representing the newly applied license. Common fields include the license owner, issuance date, expiration date, and applicable limits. The following table lists all available fields.

Table: License Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
expiresAtDateTimeyes Long-Term The time at which the license expires.
issuedAtDateTimeyes Long-Term The time at which the license was issued.