addStarToSearchDomain()

API Stability Long-Term

The addStarToSearchDomain() GraphQL mutation is used to add a star to a repository or to a view.

For more information on searching repositories and views, see the Search Data documentation page. For information on repositories, see the Manage Repositories and Views documentation page. You may also want to look at the Repositories page for related information.

Syntax

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

graphql

addStarToSearchDomain(
      name: string!
   ): SearchDomain!

There is no special input datatype for this mutation field. Below is an example of how it might be used:

Raw

graphql

mutation {
  addStarToSearchDomain(name: "humio")
  { id, description }
}

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 {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}"
}
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 {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}"
}
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 { ^
  addStarToSearchDomain(name: \"humio\") ^
  { id, description } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}"
}'
    "$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 {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}";
$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 {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}"
}'''

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 {
  addStarToSearchDomain(name: \"humio\")
  { id, description }
}"
}
);


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": {
    "addStarToSearchDomain": {
      "id": "aK9GKAsTnMXfRxT8Fpecx3fX",
      "description": null
    }
  }
}

Returned Datatypes

The mutation field returns data using the SearchDomain interface. Below is a list of parameters returned for this and a description of each:

Table: SearchDomain

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: Aug 21, 2025
`action(id: string): Action`	multiple	yes	`Long-Term`	A saved action. See Action.
`actions(actionIds: [string]): [Action]`	multiple	yes	`Long-Term`	A list of saved actions. See Action.
`aggregateAlert(id: string): AggregateAlert`	multiple	yes	`Long-Term`	A saved aggregate alert. See AggregateAlert.
`aggregateAlerts`	[`AggregateAlert`]	yes	`Long-Term`	A list of saved aggregate alerts. See AggregateAlert.
`alert(id: string): Alert`	multiple	yes	`Long-Term`	A saved alert. See Alert.
`alerts`	[`Alert`]	yes	`Long-Term`	Saved alerts. See Alert.
`allowedViewActions`	[`ViewAction`]	yes	`Long-Term`	Returns the all actions the user is allowed to perform on the view. See ViewAction.
`automaticSearch`	boolean	yes	`Long-Term`	Whether to execute automatically the default search query.
`availablePackages(filter: string, tags: [PackageTag], categories: [string]): [PackageRegistrySearchResultItem]`	multiple	yes	`Long-Term`	Returns a list of available packages that can be installed. PackageTag is a scalar. See PackageRegistrySearchResultItem.
`dashboard(id: string): Dashboard`	multiple	yes	`Long-Term`	The default or initial Dashboard to use. See Dashboard.
`dashboards`	[`Dashboard`]	yes	`Long-Term`	All dashboards available on the view. See Dashboard.
`defaultQuery`	`SavedQuery`		`Long-Term`	The default query used for the search domain when none is selected. See SavedQuery.
`deletedDate`	long		`Long-Term`	The point in time the search domain was marked for deletion.
`description`	string		`Long-Term`	A description of the search domain.
`fileFieldSearchfileFieldSearch(fileName: string, fieldName: string, prefixFilter: string, valueFilters: [FileFieldFilterType], fieldsToInclude: [string], maxEntries: integer): [[DictionaryEntryType]]`	multiple	yes	`Long-Term`	Used to search fields in a CSV or JSON file. See FileFieldFilterType and DictionaryEntryType.
`files`	[`File`]	yes	`Long-Term`	Files belonging to the search domain. See File.
`filterAlert(id: string): FilterAlert`	multiple	yes	`Long-Term`	A saved filter alert. See FilterAlert.
`filterAlerts`	[`FilterAlert`]	yes	`Long-Term`	Saved filter alerts. See FilterAlert.
`groups`	[`Group`]	yes	`Long-Term`	Groups with assigned roles. See Group.
`hasPackageInstalled(packageId: VersionedPackageSpecifier): boolean`	multiple	yes	`Long-Term`	Whether there is an installed package. VersionedPackageSpecifier is a scalar.
`id`	string	yes	`Long-Term`	The unique identifier for the search domain.
`installedPackages`	[`PackageInstallation`]	yes	`Long-Term`	List packages installed on a specific view or repository. See PackageInstallation.
`interactions`	[`ViewInteraction`]	yes	`Long-Term`	All interactions defined on the view. See ViewInteraction.
`isActionAllowed(action: ViewAction): boolean`	multiple	yes	`Long-Term`	Whether the current user is allowed to perform the action. See ViewAction.
`isStarred`	boolean	yes	`Long-Term`	Whether the search domain is highlighted with a star.
`name`	`RepoOrViewName`	yes	`Long-Term`	The name of the search domain. RepoOrViewName is a scalar.
`packageV2(packageId: VersionedPackageSpecifier): Package2`	multiple	yes	`Long-Term`	Returns a specific version of a package given a package version. VersionedPackageSpecifier is a scalar value. See Package2.
`packageVersions(packageId: UnversionedPackageSpecifier): [RegistryPackageVersionInfo]`	multiple	yes	`Long-Term`	The available versions of a package. UnversionedPackageSpecifier is a scalar. See RegistryPackageVersionInfo.
`permanentlyDeletedAt`	long		`Long-Term`	The point in time the search domain will not be restorable anymore.
`recentQueriesV2`	[`RecentQuery`]	yes	`Long-Term`	All recent queries for the search domain. See RecentQuery.
`reposExcludedInSearchLimit`	[string]	yes	`Long-Term`	Repositories not part of the search limitation.
`resource`	string	yes	`Short-Term`	The resource identifier for the search domain.
`savedQueries`	[`SavedQuery`]	yes	`Long-Term`	The saved queries. See SavedQuery.
`savedQuery(id: string): SavedQuery`	multiple	yes	`Long-Term`	A saved query. See SavedQuery.
`scheduledReport(id: string): ScheduledReport`	multiple	yes	`Long-Term`	A saved scheduled report. See ScheduledReport.
`scheduledReports`	[`ScheduledReport`]	yes	`Long-Term`	Saved scheduled reports. See ScheduledReport.
`scheduledSearch(id: string): ScheduledSearch`	multiple	yes	`Long-Term`	A saved scheduled search. See ScheduledSearch.
`scheduledSearches`	[`ScheduledSearch`]	yes	`Long-Term`	The scheduled searches to use with the search domain. See ScheduledSearch.
`searchLimitedMs`	long		`Long-Term`	Limit in milliseconds to which searches should are limited.
`starredFields`	[string]	yes	`Long-Term`	All fields in the search domain to mark with a star.
`tags`	[string]	yes	`Long-Term`	All tags from all datasources.
`users`	[`User`]	yes	`Long-Term`	Users who have access to the search domain. See User.
`usersandgroups(search: string, skip: integer, limit: integer): UsersAndGroupsSearchResultSet`	multiple		`Long-Term`	Users and groups associated with the search domain. See UsersAndGroupsSearchResultSet.
`usersV2(search: string, permissionFilter: Permission, skip: integer, limit: integer): Users`	multiple		`Short-Term`	Search users with a given permission, whose email or name matches this search string. See Permission and Users.
`viewerQueryPrefix`	string	yes	`Long-Term`	The query prefix prepended to each search in this domain.

GraphQL Mutations

GraphQL API Stability

GraphQL Groups

GraphQL Queries

GraphQL Datatypes