Search Reference

 


rest

NOTE - Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.

rest

Synopsis

Access a REST endpoint and display the returned entities as search results.

Syntax

rest <rest-uri> [splunk_server=<string>] (<get-arg-name>=<get-arg-value>)...

Required arguments

rest-uri
Syntax: <uri>
Description: URI path to the REST endpoint.
get-arg-name
Syntax: <string>
Description: REST argument name.
get-arg-value
Syntax: <string>
Description: REST argument value.

Optional arguments

splunk_server
Syntax: splunk_server=<string>
Description: Optional, argument specifies whether or not to limit results to one specific server. Use "local" to refer to the search head.

Examples

Example 1: Access saved search jobs.

| rest /services/search/jobs count=0 splunk_server=local | search isSaved=1


Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has about using the rest command.

This documentation applies to the following versions of Splunk: 4.3 , 4.3.1 , 4.3.2 , 4.3.3 , 4.3.4 , 4.3.5 , 4.3.6 , 4.3.7 View the Article History for its revisions.


You must be logged into splunk.com in order to post comments. Log in now.

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole. Feedback you enter here will be delivered to the documentation team.

Feedback submitted, thanks!