Getting Data In

What is the syntax of the search term in REST API ?

ppang
Splunk Employee
Splunk Employee

This works:

curl -u admin:changeme -k https://localhost:8089/services/search/jobs -d"search=search 123"

These don't: ( if try to POST the REST API directly .. )

https://localhost:8089/services/search/jobs search search==123 ( Not working )

https://localhost:8089/services/search/jobs/search%20search==123 ( Not working )

https://localhost:8089/services/search/jobs/search%20search%3D123 ( Not working )

https://localhost:8089/services/search/jobs/search%20search=123 ( Not working )

https://localhost:8089/services/search/jobs?search%20search=1 (this one bring something back, but not the XML)

https://localhost:8089/services/search/jobs?search%20search%3D1 (this one bring something back, but not the XML)

What is the syntax, please?
Any suggestion ?

Thx a lot

Tags (2)
0 Karma

ineeman
Splunk Employee
Splunk Employee

This is the regular URL call. Specifically, when you specify query parameters to a URL, you specify them as such:

http://www.example.com/api/your/resource/here?param1=foo&param2=bar

In your case however, to create a search job, you need to POST, and so all the parameters go in the body of the POST request, not in the URL, so it will look like this:

http://www.example.com/services/search/jobs

with the POST body looking like this:
search=search%20123&foo=bar

When you did that with curl, it did this thing automagically.

Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Build resilience for the agentic era: Join us at Splunk Go San Jose

AI is changing how organizations build, operate, and secure digital services. As teams adopt AI agents and ...

Manage Edge Processor pipelines end to end with APIs

This guide uses the Data Management APIs to create an Edge Processor, onboard one instance, deploy a pipeline ...

Splunk Brings Proof of Control to Digital Asset Transfers

Digital assets now sit inside the core of financial services. HSBC launched its Tokenized Deposit Service in ...