Summary

The updateDefaultQueryPrefix() GraphQL mutation is used to update the default query prefix for a group in LogScale.

API Stability Long-Term

Syntax

graphql
updateDefaultQueryPrefix(
      input: UpdateDefaultQueryPrefixInput!
   ): UpdateDefaultQueryPrefixMutation!

For the input, you'll have to give the unique identifier of the group, and the default query prefix. See the Input Parameters section for details.

For the results, you can get information on the group. See the Returned Values section for what will be available.

Example

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

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 {
  updateDefaultQueryPrefix( input: 
    {
      queryPrefix: \"sales\",
      groupId: \"abc123\"
    }
  )
  { group { displayName } }
}"
}
);


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": {
    "updateDefaultQueryPrefix": {
      "group": {
        "displayName": "sales"
      }
    }
  }
}

Input Parameters

For the input, you'll have to provide the unique identifier of the group, and the default query prefix. These are described below:

Table: UpdateDefaultQueryPrefixInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 23, 2024
groupIdstringyes Long-TermThe unique identifier of the group.
queryPrefixstring  Long-TermThe prefix of the default query.

Returned Values

For the results, you can get information on the group, such as how many users, a list of them, and which assets they can access. You can also get a list of roles and what they entail. Since this mutation affects query prefixes, you may want to get the defaultQueryPrefix and queryPrefixes values.

Table: UpdateDefaultQueryPrefixMutation Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 4, 2024
groupGroupyes Long-TermThe group for which to update the default query prefix. See Group.