unstarQuery()

API Stability	`Long-Term`

The unstarQuery() GraphQL mutation may be used to unstar a saved query in user settings in LogScale.

For more information on saved queries, see the User Functions (Saved Searches) reference page where saved queries are discussed. Also, look at the Searching Data documentation page as it relates to recent queries and saving queries.

Syntax

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

graphql

unstarQuery(
      input: RemoveStarFromQueryInput!
   ): SavedQueryStarredUpdate!

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

Show:

graphql

mutation {
  unstarQuery( input:
    { searchDomainName:"humio",
      savedQueryId: "abc123" }
  )
    { savedQuery { isStarred } }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  unstarQuery( input: ^
    { searchDomainName:\"humio\", ^
      savedQueryId: \"abc123\" } ^
  ) ^
    { savedQuery { isStarred } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  unstarQuery( input:
    { searchDomainName:\"humio\",
      savedQueryId: \"abc123\" }
  )
    { savedQuery { isStarred } }
}"
}
);


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

Show:

json

{
  "data": {
    "unstarQuery": {
      "savedQuery": {
        "isStarred": false
      }
    }
  }
}

Given Datatypes

For the given datatype, RemoveStarFromQueryInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: RemoveStarFromQueryInput

Parameter	Type	Required	Stability	Description
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 19, 2024
`savedQueryId`	string	yes	`Long-Term`	The unique identifier of the saved query from which to remove the star.
`searchDomainName`	string	yes	`Long-Term`	The unique identifier of the search domain associated with the saved query.

Returned Datatypes

The returned datatype SavedQueryStarredUpdate has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SavedQueryStarredUpdate

Parameter	Type	Required	Stability	Description
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: Oct 3, 2024
`savedQuery`	`SavedQueryIsStarred`	yes	`Long-Term`	The started query to update. See `SavedQueryIsStarred`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

unstarQuery()

Syntax

Given Datatypes

Returned Datatypes

Enter search term