Summary

In the LogScale user interface, fields in a repository can be highlighted with a star next to them. At some point, though, you may want to remove a star from a field. To do this, you can use the removeStarFromField() GraphQL mutation.

API Stability Long-Term

Syntax

graphql
removeStarFromField(
      input: RemoveStarToFieldInput!
   ): RemoveStarToFieldMutation!

For the input, you have to give the name of the repository or view, and the name of the field you want to star. See the Input Parameters section for details.

For the results, you can get a list of fields that have been starred. See the Returned Values section farther down this page.

Example

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

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 {
  removeStarFromField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}
);


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": {
    "removeStarFromField": {
      "starredFields": [
        "@timestamp"
      ]
    }
  }
}

Input Parameters

For the input, you'll have to give the name of the repository or view, and the name of the field from which you want to remove the star. To see an example of how to get this list, click on the Show Query link farther up this page.

Table: RemoveStarToFieldInput 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 19, 2024
fieldNamestringyes Long-TermThe name of the field from which to remove the star.
searchDomainNamestringyes Long-TermThe search domain where the field is located.

Returned Values

For the results, you can get a list of remaining fields that have stars, in case you want to remove more.

Table: RemoveStarToFieldMutation 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 3, 2024
starredFields[string]yes Long-TermFields which are marked with a star.