The Searchdomain interface includes settings various settings.

Table: Searchdomain

ParameterTypeRequired[a]DefaultDescription
idstringyes interface searchdomain The unique identifier for the search domain.
nameRepoOrViewNameyes The name of the search domain. The type, RepoOrViewName is a scalar.
descriptionstring  A description of the search domain.
deletedDatelong  The point in time the search domain was marked for deletion.
permanentlyDeletedAtlong  The point in time the search domain will not be restorable anymore.
isStarredbooleanyes Whether the search domain is highlighted with a star.
packagepackageIdVersionedPackageSpecifier): RegistryPackageyes Returns a specific version of a package given a package version. This is a scalar value. However, it has been deprecated since September 3, 2021. This field returns a type with an interface that is being removed. Use instead package2.
packageV2packageIdVersionedPackageSpecifier: Package2yes Returns a specific version of a package given a package version. This is a scalar value. Returns [Package2]. See the [Package2] table.
packageVersionspackageIdUnversionedPackageSpecifier: RegistryPackageVersionInfoyes The available versions of a package. Preview: This may be moved to the Package2 object.
availablePackagesAvailablePackagesyes Returns a list of available packages that can be installed. See the Search Domain – AvailablePackages Table.
installedPackagesPackageInstallationyes List packages installed on a specific view or repo. See the PackageInstallation Table.
hasPackageInstalledpackageIdVersionedPackageSpecifier: booleanyes This is a scalar value.
defaultQuerySavedQueryyes The default query used for the search domain when none is selected.
usersUseryes Users who have access to the search domain.
usersandgroupssearchstringskipinteger=nlimitinteger=n: UsersAndGroupsSearchResultSetyes Users and groups associated with the search domain. See the Search Domain – UsersAndGroupsS Table.
groupsGroupyes Groups with assigned roles.
starredFieldsstringyes text
recentQueriesJSONyes This parameter has been deprecated since April 23, 2021. It used internal JSON structure generated in the User Interface. Use instead recentQueriesV2.
recentQueriesV2RecentQueryyes text
automaticSearchbooleanyes text
filesFileyes text
fileFieldSearchstringyes text Returns [DictionaryEntryType]. See the SearchDomain – fileFieldSearch Table.
isActionAllowedactionViewAction: booleanyes Check if the current user is allowed to perform the given action on the view.
allowedViewActionsViewActionyes Returns the all actions the user is allowed to perform on the view.
permissionsViewPermissionsTypeyes This has been deprecated since April 6, 20226. These are separate from actual permissions in Humio. Use instead isActionAllowed.
viewerQueryPrefixstringyes The query prefix prepended to each search in this domain.
dashboardsDashboardsyes All dashboards available on the view.
dashboardidstring: Dashboardyes text
queriesSavedQueryyes Saved Queries stored on the entity. This has been deprecated since March 3, 2021. This field is duplicated. Use instead savedQueries.
tagsstringyes All tags from all datasources.
alertidstring: Alertyes A saved alert. Returns Alert. See the Alert table.
alertsAlertyes Saved alerts. See the Alert table.
savedQueryidstring: SavedQueryyes A saved query. Returns SavedQuery. See the SavedQuery table.
savedQueriesSavedQueryyes The saved queries. See the SavedQuery table.
scheduledSearchidstring: ScheduledSearchyes A saved scheduled search. Returns ScheduledSearch. See the ScheduledSearch table.
scheduledSearchesScheduledSearchyes text
assetsassetTypeAssetType: Assetyes Returns a list of assets. Filter asset type to limit the returned assets. Returns Asset. See the Asset table.
actionidstring: Actionyes A saved action. Returns Action. See the Action table.
actionsActionyes A list of saved actions. See the Action table.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.