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

Summary

The starQuery() mutation stars a saved query in your user settings. Starred saved queries appear prominently in the saved queries list in the LogScale UI. Use this mutation to mark frequently used queries for quick access.

Syntax

graphql
starQuery(
      input: AddStarToQueryInput!
   ): BooleanResultType!

The mutation accepts a single required input argument of type AddStarToQueryInput!. Provide the search domain name and the unique identifier of the saved query to star. See the Input Parameters section for details on each field.

The mutation returns a BooleanResultType! object. Request the result field, which returns true when the star was applied successfully. See the Returned Values section for details.

Hide Query Example

Show Saved Queries Query

Example

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

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 {
  starQuery( input:
    {
      searchDomainName: \"humio\",
      savedQueryId: \"abc123\"
    }
  )
  { result }
}"
}
);


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": {
    "starQuery": {
      "result": true
    }
  }
}

Input Parameters

The input argument requires the name of the search domain (repository or view) and the unique identifier of the saved query to star. Use the repository() query with the savedQueries field to retrieve saved query identifiers. See the Show Saved Queries Query example in the preceding Syntax section.

Table: AddStarToQueryInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
savedQueryIdStringyes Long-Term The unique identifier for the saved search query.
searchDomainNameStringyes Long-Term The name of the search domain associated with the saved query.

Returned Values

The mutation returns a BooleanResultType! object. Request the result field, which returns true when the star was applied successfully and false otherwise.

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
resultBooleanyes Long-Term Whether the mutation was performed successfully.