Getting Data In

Splunk API paging

Zambonilli
Explorer

I'm running into an issue with using the Splunk API and it only returning 30 records. I've searched the Splunk API, ATOM and opensearch documentation and I am still unable to determine how to page the records.

For example I am querying to get the current data inputs by calling https://%basesplunkurl%:8089/services/data/inputs/monitor

This returns a document with 30 records and the opensearch fields indicating that there is 34 records total.

opensearch:totalResults34/opensearch:totalResults
opensearch:itemsPerPage30/opensearch:itemsPerPage
opensearch:startIndex0/opensearch:startIndex

What do I have to do to get the next page of results? In this example the last 4 data input records?

Tags (3)
0 Karma
1 Solution

Zambonilli
Explorer

So I used the web console and the splunkd_access.log file to figure out that the requests to these objects uses the opensearch REST parameters.

I changed my url to include a trailing ?count=-1 to return all records.

EX:
https://%basesplunkurl%:8089/services/data/inputs/monitor?count=-1

View solution in original post

itay
New Member

In general, you can use the offset parameter to get the next offset of results. So in your case, you'd pass in offset=30.

0 Karma

Zambonilli
Explorer

So I used the web console and the splunkd_access.log file to figure out that the requests to these objects uses the opensearch REST parameters.

I changed my url to include a trailing ?count=-1 to return all records.

EX:
https://%basesplunkurl%:8089/services/data/inputs/monitor?count=-1

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!

Mile High Learning with Splunk University, Denver, Colorado

If Denver is known for its mile-high elevation, Splunk University is about to raise the bar on technical ...

IT Service Intelligence 5.0 Series: Your Guide to the June Launch

We are excited to announce the June release of Splunk IT Service Intelligence (ITSI) 5.0. This update ...

Agent Mode Engaged! Enchaining Agentic Operations with Splunk AI Assistant 2.0

    Are you ready to transform how your team handles complex data requests? We invite you to our upcoming ...