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 Searching Data documentation page. For information on repositories, see the Repositories & 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!

Below is an example of how this mutation field 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 $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes