API Stability Short-Term

The setDynamicConfig() GraphQL mutation is used to set a dynamic configuration. It requires root level access.

For more information on configuring all aspects of LogScale, see the Configuration Settings reference section. For information on configuration values, see Dynamic Configuration Parameters.

Syntax

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

graphql
setDynamicConfig(
      input: DynamicConfigInputObject!
   ): boolean

There are no special returned datatypes for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: "VALUE_FOR_CONFIG" 
    }
  )
}
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 {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}"
}
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 {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}"
}
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 { ^
  setDynamicConfig(input:  ^
    { config: NAME_OF_CONFIG,  ^
      value: \"VALUE_FOR_CONFIG\"  ^
    } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}"
}'
    "$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 {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}";
$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 {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}"
}'''

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 {
  setDynamicConfig(input: 
    { config: NAME_OF_CONFIG, 
      value: \"VALUE_FOR_CONFIG\" 
    }
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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" : {
      "setDynamicConfig" : true
   }
}

To unset a dynamic configuration, see the unsetDynamicConfig() mutation field.

Given Datatypes

DynamicConfigInputObject has a couple of parameters, and several sub-parameters. Below is a list of them along with descriptions of each. For a list of values for each enumerated option, see Dynamic Configuration Parameters.

Table: DynamicConfigInputObject

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 18, 2024
configDynamicConfigyes Short-TermWhat to configure dynamically. See DynamicConfig .
valuestringyes Short-TermThe value for which configuration is given.