CreateScheduledSearchV2 is used to input data for creating a scheduled search.

Table: CreateScheduledSearchV2

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 28, 2025
actions[string]yes DeprecatedA list of ids or names for actions to fire on query result. Actions in packages can be referred to as packagescope/packagename:actionname.
backfillLimitinteger  DeprecatedUser-defined limit, which caps the number of missed searches to backfill, e.g. in the event of a shutdown.
descriptionstring  DeprecatedDescription of the scheduled search.
enabledboolean trueDeprecatedFlag indicating whether the scheduled search is enabled. The default is true.
labels[string]yes[ ]DeprecatedLabels attached to the scheduled search.
maxWaitTimeSecondslong  DeprecatedThe maximum number of seconds to wait for ingest delay and query warnings. Only allowed when queryTimestamp is IngestTimestamp where it's mandatory.
namestringyes DeprecatedName of the scheduled search.
queryOwnershipTypeQueryOwnershipTypeyes DeprecatedOwnership of the query run by this scheduled search. If value is User, ownership will be based on the runAsUserId field. See QueryOwnershipType.
queryStringstringyes DeprecatedLogScale query to execute.
queryTimestampTypeQueryTimestampTypeyes DeprecatedThe timestamp type to use for the query. Running on @ingesttimestamp is only available with feature flag, ScheduledSearchIngestTimestamp. See QueryTimestampType.
runAsUserIdstring  DeprecatedThe scheduled search will run with the permissions of the user corresponding to this id if the queryOwnershipType field is set to User. If the queryOwnershipType is set to Organization, whilst runAsUserId is set, this will result in an error. If not specified, the scheduled search will run with the permissions of the calling user. It requires the 'ChangeTriggersToRunAsOtherUsers' permission to set this field to a user id different from the calling user.
schedulestringyes DeprecatedCron pattern describing the schedule to execute the query on.
searchIntervalOffsetSecondslong  DeprecatedThe offset of the search interval in seconds. Only allowed when queryTimestampType is EventTimestamp where it's mandatory.
searchIntervalSecondslong  DeprecatedThe search interval in seconds.
timeZonestringyes DeprecatedTime zone of the schedule. Currently this field only supports UTC offsets like 'UTC', 'UTC-01' or 'UTC+12:45'.
viewNamestringyes DeprecatedName of the view of the scheduled search.