Documentation > Splunk > REST API Reference > Examples using the Splunk REST API

REST API Reference

 


REST API reference
Using Splunk's REST API

Examples using the Splunk REST API

Contents

Examples using the Splunk REST API

This section shows some typical use cases for the Splunk REST API. These examples show how to use the servicesNS endpoints to access resources within a user/app context. They also show some of the additional operations available, such as moving an object to a different app or changing the permissions of an object.


Create a new Splunk object for a specific context

Create a saved search for the user Alice that is available from the app, myapp. This saved search is private to Alice. 

curl -k -u alice:pass https://localhost:8089/servicesNS/alice/myapp/saved/searches/  \
        -d name=mysearch \
        -d search=*



Edit a Splunk object

Change the above search created for Alice.

Because this search is private to Alice, she can edit the search. 

curl -k -u alice:pass https://localhost:8089/servicesNS/alice/myapp/saved/searches/mysearch \
        -d search="index=mai*"



Share an object to an app, modify its permissions, and edit it

Make Alice's saved search, mysearch, available through the app, myapp. Allow all users permissions to read the saved search. 

curl -k -u admin:pass https://localhost:8089/servicesNS/alice/myapp/saved/searches/mysearch/acl  \
        -d perms.read=* \
        -d owner=alice \
        -d sharing=app


Edit the search at the shared location. Because the search is now a shared resource, use <nobody> for the <user> context. 

curl -k -u alice:pass https://localhost:8089/servicesNS/nobody/myapp/saved/searches/mysearch  \
        -d search="index=main"



Move an object to a different app

The saved search that was previously available to all in the context of myapp is now only available in the context of otherapp. 

curl -k -u admin:pass https://localhost:8089/servicesNS/nobody/myapp/saved/searches/mysearch/move  \
        -d user=nobody \
        -d app=otherapp


Access objects available in all user/app contexts

Using wildcards, access all saved searches that you have permission to view.

For an admin user, this includes other user's private saved searches.

For a non-admin user, you retrieve only saved searches you have permission to view. 

curl -k -u admin:pass https://localhost:8089/servicesNS/-/-/saved/searches

curl -k -u alice:pw https://localhost:8089/servicesNS/-/-/saved/searches


Retrieved from "http://docs.splunk.com/Documentation/Splunk/5.0.2/RESTAPI/RESTbasicexamples"

This documentation applies to the following versions of Splunk: 5.0 , 5.0.1 , 5.0.2 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!