API Stability Long-Term

The updateLicenseKey() GraphQL mutation is used to update the license key for a LogScale cluster. This operation requires ManageCluster permissions if the cluster has existing license.

For more information on registering with LogScale Cloud, see the Starting with LogScale Cloud configuration page.

Syntax

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

graphql
updateLicenseKey(
     license: string!
   ): License!

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

Show:
graphql
mutation {
  updateLicenseKey( 
      license: "abc123"
  )
  { issuedAt }
}
Example Responses
Show:
json
{
  "data": {
    "updateLicenseKey": {
      "issuedAt": "2024-07-18T12:48:27Z"
    }
  }
}

Returned Datatypes

The returned datatype License has a few parameters. Below is a list of them along with a description of each:

Table: License

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
expiresAtdatetimeyes Long-TermThe time at which the license expires.
issuedAtdatetimeyes Long-TermThe time at which the license was issued.