
KV store endpoint examples
storage/collections/config GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/config
XML Response
. . . <title>collections-conf</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config</id> <updated>2014-09-02T11:28:27-07:00</updated> <generator build="229629" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/_new" rel="create"/> <link href="/servicesNS/nobody/search/storage/collections/config/_reload" rel="_reload"/> ... opensearch nodes elided ... <s:messages/> <entry> <title>kvstoredemo</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config/kvstoredemo</id> <updated>2014-09-02T11:28:27-07:00</updated> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo" rel="alternate"/> <author> <name>admin</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo" rel="list"/> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo/_reload" rel="_reload"/> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo" rel="edit"/> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo" rel="remove"/> <link href="/servicesNS/nobody/search/storage/collections/config/kvstoredemo/disable" rel="disable"/> <content type="text/xml"> <s:dict> <s:key name="disabled">0</s:key> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="eai:appName">search</s:key> <s:key name="eai:userName">nobody</s:key> <s:key name="profilingEnabled">false</s:key> <s:key name="profilingThresholdMs">100</s:key> </s:dict> </content> </entry> <entry> <title>test</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test</id> <updated>2014-09-02T11:28:27-07:00</updated> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="alternate"/> <author> <name>admin</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="list"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/_reload" rel="_reload"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="edit"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="remove"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/disable" rel="disable"/> <content type="text/xml"> <s:dict> <s:key name="disabled">0</s:key> <s:key name="eai:acl"> ... elided ...</s:key> <s:key name="eai:appName">search</s:key> <s:key name="eai:userName">nobody</s:key> <s:key name="profilingEnabled">false</s:key> <s:key name="profilingThresholdMs">100</s:key> </s:dict> </content> </entry>
storage/collections/config POST
XML
XML Request
curl -k -u admin:changeme -d name=test1 https://localhost:8089/servicesNS/nobody/search/storage/collections/config
XML Response
. . . <title>collections-conf</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config</id> <updated>2014-09-02T11:25:32-07:00</updated> <generator build="229629" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/_new" rel="create"/> <link href="/servicesNS/nobody/search/storage/collections/config/_reload" rel="_reload"/> ... opensearch nodes elided ... <s:messages/> <entry> <title>test1</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test1</id> <updated>2014-09-02T11:25:32-07:00</updated> <link href="/servicesNS/nobody/search/storage/collections/config/test1" rel="alternate"/> <author> <name>admin</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/test1" rel="list"/> <link href="/servicesNS/nobody/search/storage/collections/config/test1/_reload" rel="_reload"/> <link href="/servicesNS/nobody/search/storage/collections/config/test1" rel="edit"/> <link href="/servicesNS/nobody/search/storage/collections/config/test1" rel="remove"/> <link href="/servicesNS/nobody/search/storage/collections/config/test1/disable" rel="disable"/> <content type="text/xml"> <s:dict> <s:key name="disabled">0</s:key> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="eai:appName">search</s:key> <s:key name="eai:userName">nobody</s:key> <s:key name="profilingEnabled">false</s:key> <s:key name="profilingThresholdMs">100</s:key> </s:dict> </content> </entry>
storage/collections/config/{collection} DELETE
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test -X DELETE
XML Response
. . . <title>collections-conf</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config</id> <updated>2014-06-02T20:08:11-07:00</updated> <generator build="210538" version="20140530"/> <author> <name>Splunk</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/_new" rel="create"/> <link href="/servicesNS/nobody/search/storage/collections/config/_reload" rel="_reload"/> ... opensearch nodes elided ... <s:messages/>
storage/collections/config/{collection} GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/collections/config/test
XML Response
. . . <title>collections-conf</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config</id> <updated>2014-09-02T11:42:54-07:00</updated> <generator build="229629" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/_new" rel="create"/> <link href="/servicesNS/nobody/search/storage/collections/config/_reload" rel="_reload"/> ... opensearch nodes elided ... <s:messages/> <entry> <title>test</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test</id> <updated>2014-09-02T11:42:54-07:00</updated> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="alternate"/> <author> <name>admin</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="list"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/_reload" rel="_reload"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="edit"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="remove"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/disable" rel="disable"/> <content type="text/xml"> <s:dict> <s:key name="disabled">0</s:key> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="eai:appName">search</s:key> <s:key name="eai:attributes"> ... elided ... </s:key> <s:key name="eai:userName">nobody</s:key> <s:key name="profilingEnabled">false</s:key> <s:key name="profilingThresholdMs">100</s:key> </s:dict> </content> </entry>
storage/collections/config/{collection} POST
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test -d 'index.foo={"a": 1}' -d 'index.bar={"b": -1}' -d "field.a=number" -d "field.b=cidr"
XML Response
. . . <title>collections-conf</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config</id> <updated>2014-09-02T11:50:57-07:00</updated> <generator build="229629" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/_new" rel="create"/> <link href="/servicesNS/nobody/search/storage/collections/config/_reload" rel="_reload"/> ... opensearch nodes elided ... <s:messages/> <entry> <title>test</title> <id>https://localhost:8089/servicesNS/nobody/search/storage/collections/config/test</id> <updated>2014-09-02T11:50:57-07:00</updated> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="alternate"/> <author> <name>admin</name> </author> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="list"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/_reload" rel="_reload"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="edit"/> <link href="/servicesNS/nobody/search/storage/collections/config/test" rel="remove"/> <link href="/servicesNS/nobody/search/storage/collections/config/test/disable" rel="disable"/> <content type="text/xml"> <s:dict> <s:key name="disabled">0</s:key> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="eai:appName">search</s:key> <s:key name="eai:userName">nobody</s:key> <s:key name="index.foo">{"a": 1} index.bar={"b": -1} field.a=number field.b=cidr</s:key> <s:key name="profilingEnabled">false</s:key> <s:key name="profilingThresholdMs">100</s:key> </s:dict> </content> </entry>
storage/collections/data/{collection} DELETE
JSON DELETE all
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/data/testCollectionA -X DELETE
JSON Response
None
storage/collections/data/{collection} GET
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/data/testCollectionA
JSON Response
[ { "myKey" : "abc", "_user" : "nobody", "_key" : "5410be5441ba15298e4624d1" } ]
storage/collections/data/{collection} POST
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/data/testCollectionA -H "Content-Type: application/json" -d '{ "myKey": "abc", "myOtherKey": "abcdef"}'
JSON Response
{"_key":"5410be5441ba15298e4624d1"}
storage/collections/data/{collection}/{key} DELETE
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/collections/data/testCollectionA/5410caf041ba15298e4624d6 -X DELETE
JSON Response
None
storage/collections/data/{collection}/{key} GET
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/collections/data/testCollectionA/5410c8dc41ba15298e4624d5
JSON Response
{ "myKey" : "abc", "myOtherKey" : "uvwxyz", "_user" : "nobody", "_key" : "5410c8dc41ba15298e4624d5" }
storage/collections/data/{collection}/{key} POST
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/data/testCollectionA/5410c8dc41ba15298e4624d5 -H "Content-Type: application/json" -d '{ "myKey": "fizz"}'
JSON Response
{"_key":"5410c8dc41ba15298e4624d5"}
storage/collections/data/{collection}/batch_save POST
JSON
JSON Request
curl -k -u admin:changeme https://localhost:8089/servicesNS/nobody/search/storage/collections/data/testCollectionA/batch_save -H "Content-Type: application/json" -d '[{ "_key": "5410c43241ba15298e4624d3", "name": "AAAAAAAA" },{ "name": "A" }]}'
JSON Response
[ "5410c43241ba15298e4624d3", "5418c54e41ba152267763c01" ]
PREVIOUS KV Store endpoint descriptions |
NEXT License endpoint descriptions |
This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11, 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10
Feedback submitted, thanks!