ScheduledSearch

The ScheduledSearch datatype includes settings various settings.

Table: ScheduledSearch

ParameterTypeRequired[a]DefaultDescription
idstringyes datatype scheduledsearch The unique identifier of the scheduled search.
namestringyes The name of the scheduled search.
descriptionstring  A description of the scheduled search.
queryStringstringyes The Humio query to execute.
startstringyes The start of the relative time interval for the query.
endstringyes The end of the relative time interval for the query.
timeZonestringyes Time zone of the schedule. Currently, this field only supports UTC offsets like 'UTC', 'UTC-01' or 'UTC+12:45'.
schedulestringyes The cron pattern describing the schedule to execute the query on.
backfillLimitintegeryes User-defined limit, which caps the number of missed searches to backfill, e.g. in the event of a shutdown.
enabledbooleanyes Whether the scheduled search is enabled.
actionsstringyes List of unique identifiers for actions to fire on query result.
runAsUserUseryes The unique identifier of the user which the scheduled search is running as.
lastScheduledSearchlong  The UNIX timestamp for end of last query execution.
timeOfNextPlannedExecutionlong  The UNIX timestamp for next planned search.
lastErrorstring  The last error encountered while running the search.
labelsstringyes The labels added to the scheduled search.
isStarredbooleanyes Whether the calling user has 'starred' the scheduled search.
yamlTemplateYAMLyes A template that can be used to recreate the scheduled search.
packagePackageInstallationyes The related package. See PackageInstallation 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.