Skip to main content

Create search job in Splunk

Create search job in Splunk.

Application

  • Splunk

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected AccountThe connected account to use for the requestConnected AccountYes
QuerySearch language string to execute, in Splunk's Search Processing LanguageText (Long)Yes
Ad hoc search levelPredefined Choice ListNo
Auto-cancel after (seconds)Seconds after which the search job automatically cancelsNumberNo
Auto-finalize after (num events)Auto-finalize the search after at least this many events are processedNumberNo
Auto pause after (seconds)Seconds of inactivity after which the search job automatically pausesNumberNo
Earliest indexThe earliest index time for the search (inclusive)DatetimeNo
Earliest timeThe earliest cut-off for the search (inclusive)DatetimeNo
Exec modePredefined Choice ListNo
Indexed real time offsetSeconds of disk sync delay for indexed real-time searchNumberNo
Latest indexThe latest index time for the search (inclusive)DatetimeNo
Latest timeThe latest cut-off for the search (inclusive)DatetimeNo
Max timeNumber of seconds to run this search before finalizing. Enter 0 to never finalizeNumberNo
NamespaceApplication namespace in which to restrict searchesText (Short)No
Reduce frequencyHow frequently to run the MapReduce reduce phase on accumulated map valuesNumberNo
Remote server listComma-separated list of (possibly wildcarded) servers from which raw events should be pulled. This same server list is to be used in subsearchesText (Long)No
Reuse limit (seconds)Number of seconds ago to check when an identical search is started and return the job’s search ID instead of starting a new jobNumberNo
Required fieldName of a required field to add to the search. Even if not referenced or used directly by the search, a required field is still included in events and summary endpointsText (Short)No
Search modePredefined Choice ListNo
Status bucketsThe most status buckets to generate. Set to 0 generate no timeline informationNumberNo
TimeoutNumber of seconds to keep this search after processing has stoppedNumberNo
Workload poolNew workload pool where the existing running search should be placedText (Short)No

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A