Splunk

App · 25 actions

Run Splunk search jobs, read results and events, manage saved searches, inspect fired alerts, and discover indexes, apps and source types.

Actions

ActionWhat it does
Control search jobControl search job.
Create saved searchCreate saved search.
Create search jobCreate search job.
Delete saved searchDelete saved search.
Delete search jobDelete search job.
Dispatch saved searchDispatch saved search.
Get appGet app.
Get current contextGet current context.
Get fired alertsGet fired alerts.
Get indexGet index.
Get saved searchGet saved search.
Get search eventsGet search events.
Get search jobGet search job.
Get search previewGet search preview.
Get search resultsGet search results.
Get server infoGet server info.
Get sourcetypeGet sourcetype.
List appsList apps.
List fired alertsList fired alerts.
List indexesList indexes.
List saved search historyList saved search history.
List saved searchesList saved searches.
List search jobsList search jobs.
List sourcetypesList sourcetypes.
Update saved searchUpdate saved search.

Control search job

Control search job.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.
OperationoperationtextRequired
How to change the search job.One of: pause, unpause, finalize, cancel, touch.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Create saved search.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
NamenametextRequired
The name.
SearchsearchtextRequired
A complete SPL query, beginning with search or a generating command such as | makeresults.
Descriptiondescriptiontext
The description.
Is scheduledis_scheduledtrue/false
The is scheduled.
Cron schedulecron_scheduletext
Cron expression when scheduling is enabled.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Create search job

Create search job.

Inputs

SearchsearchtextRequired
A complete SPL query, beginning with search or a generating command such as | makeresults.
Earliest timeearliest_timedate and time
Earliest event time. The date and time picker is converted to Unix seconds.
Latest timelatest_timedate and time
Latest event time. The date and time picker is converted to Unix seconds.
Max countmax_countnumber
The max count.From 1 to 500000.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "sid": "qa-search-job"
  }
}

Delete saved search.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Search namesearch_nametextRequired
The saved search name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Delete search job

Delete search job.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Dispatch saved search.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Search namesearch_nametextRequired
The saved search name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "sid": "qa-search-job"
  }
}

Get app

Get app.

Inputs

AppapptextRequired
Select the Splunk app namespace.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get current context

Get current context.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get fired alerts

Get fired alerts.

Inputs

Alert namealert_nametextRequired
The alert name.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get index

Get index.

Inputs

Index nameindex_nametextRequired
The index name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get saved search.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Search namesearch_nametextRequired
The saved search name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get search events

Get search events.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get search job

Get search job.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get search preview

Get search preview.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get search results

Get search results.

Inputs

SidsidtextRequired
The search job ID from Create search job or Dispatch saved search.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get server info

Get server info.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

Get sourcetype

Get sourcetype.

Inputs

SourcetypesourcetypetextRequired
The sourcetype.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

List apps

List apps.

Inputs

Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List fired alerts

List fired alerts.

Inputs

Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List indexes

List indexes.

Inputs

Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List saved search history

List saved search history.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Search namesearch_nametextRequired
The saved search name.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List saved searches

List saved searches.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List search jobs

List search jobs.

Inputs

Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

List sourcetypes

List sourcetypes.

Inputs

Countcountnumber
The count.From 1 to 1000.
Offsetoffsetnumber
The offset.At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "entry": [],
    "paging": {
      "offset": 0,
      "total": 0
    }
  }
}

Update saved search.

Inputs

OwnerownertextRequired
Saved-search owner. Use nobody for a search shared within the app.
AppapptextRequired
Select the Splunk app namespace.
Search namesearch_nametextRequired
The saved search name.
Searchsearchtext
A complete SPL query, beginning with search or a generating command such as | makeresults.
Descriptiondescriptiontext
The description.
Is scheduledis_scheduledtrue/false
The is scheduled.
Cron schedulecron_scheduletext
The cron schedule.
Disableddisabledtrue/false
The disabled.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "messages": [],
    "results": []
  }
}

On this page