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
| Action | What it does |
|---|---|
| Control search job | Control search job. |
| Create saved search | Create saved search. |
| Create search job | Create search job. |
| Delete saved search | Delete saved search. |
| Delete search job | Delete search job. |
| Dispatch saved search | Dispatch saved search. |
| Get app | Get app. |
| Get current context | Get current context. |
| Get fired alerts | Get fired alerts. |
| Get index | Get index. |
| Get saved search | Get saved search. |
| Get search events | Get search events. |
| Get search job | Get search job. |
| Get search preview | Get search preview. |
| Get search results | Get search results. |
| Get server info | Get server info. |
| Get sourcetype | Get sourcetype. |
| List apps | List apps. |
| List fired alerts | List fired alerts. |
| List indexes | List indexes. |
| List saved search history | List saved search history. |
| List saved searches | List saved searches. |
| List search jobs | List search jobs. |
| List sourcetypes | List sourcetypes. |
| Update saved search | Update saved search. |
Control search job
Control search job.
Inputs
- Sid
sidtextRequired - The search job ID from Create search job or Dispatch saved search.
- Operation
operationtextRequired - 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
Create saved search.
Inputs
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Name
nametextRequired - The name.
- Search
searchtextRequired - A complete SPL query, beginning with search or a generating command such as | makeresults.
- Description
descriptiontext - The description.
- Is scheduled
is_scheduledtrue/false - The is scheduled.
- Cron schedule
cron_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
- Search
searchtextRequired - A complete SPL query, beginning with search or a generating command such as | makeresults.
- Earliest time
earliest_timedate and time - Earliest event time. The date and time picker is converted to Unix seconds.
- Latest time
latest_timedate and time - Latest event time. The date and time picker is converted to Unix seconds.
- Max count
max_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
Delete saved search.
Inputs
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Search name
search_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
- Sid
sidtextRequired - 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
Dispatch saved search.
Inputs
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Search name
search_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
- App
apptextRequired - 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 name
alert_nametextRequired - The alert name.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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 name
index_nametextRequired - The index name.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"messages": [],
"results": []
}
}Get saved search
Get saved search.
Inputs
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Search name
search_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
- Sid
sidtextRequired - The search job ID from Create search job or Dispatch saved search.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Sid
sidtextRequired - 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
- Sid
sidtextRequired - The search job ID from Create search job or Dispatch saved search.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Sid
sidtextRequired - The search job ID from Create search job or Dispatch saved search.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Sourcetype
sourcetypetextRequired - The sourcetype.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"messages": [],
"results": []
}
}List apps
List apps.
Inputs
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Search name
search_nametextRequired - The saved search name.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
- Count
countnumber - The count.From 1 to 1000.
- Offset
offsetnumber - 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
Update saved search.
Inputs
- Owner
ownertextRequired - Saved-search owner. Use nobody for a search shared within the app.
- App
apptextRequired - Select the Splunk app namespace.
- Search name
search_nametextRequired - The saved search name.
- Search
searchtext - A complete SPL query, beginning with search or a generating command such as | makeresults.
- Description
descriptiontext - The description.
- Is scheduled
is_scheduledtrue/false - The is scheduled.
- Cron schedule
cron_scheduletext - The cron schedule.
- Disabled
disabledtrue/false - The disabled.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"messages": [],
"results": []
}
}