
System endpoint examples
messages GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/messages
XML Response
. . . <title>messages</title> <id>https://localhost:8089/services/messages</id> <updated>2011-07-08T01:14:21-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> <link href="/services/messages/_new" rel="create"/> ... opensearch elements elided ... <s:messages/> <entry> <title>restart_required</title> <id>https://localhost:8089/services/messages/restart_required</id> <updated>2011-07-08T01:14:21-07:00</updated> <link href="/services/messages/restart_required" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/messages/restart_required" rel="list"/> <link href="/services/messages/restart_required" rel="remove"/> <content type="text/xml"> <s:dict> ... eai:acl node elided ... <s:key name="restart_required">Splunk must be restarted for changes to take effect.</s:key> </s:dict> </content> </entry>
messages POST
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/messages -d name=helloMessage -d value="hello world" -d severity="info"
XML Response
. . . <title>messages</title> <id>https://localhost:8089/services/messages</id> <updated>2014-02-20T10:24:02-08:00</updated> <generator build="197187" version="6.1beta"/> <author> <name>Splunk</name> </author> <link href="/services/messages/_new" rel="create"/> ... opensearch elements elided ... <s:messages/> <entry> <title>helloMessage</title> <id>https://localhost:8089/services/messages/helloMessage</id> <updated>2014-02-20T10:24:02-08:00</updated> <link href="/services/messages/helloMessage" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/messages/helloMessage" rel="remove"/> <content type="text/xml"> <s:dict> <s:key name="helloMessage">"hello world"</s:key> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="message">"hello world"</s:key> <s:key name="severity">info</s:key> <s:key name="timeCreated_epochSecs">1392920642</s:key> </s:dict> </content> </entry>
messages/{name} DELETE
XML
XML Request
curl -k -u admin:changeme --request DELETE https://localhost:8089/services/messages/message
XML Response
. . . <title>messages</title> <id>https://localhost:8089/services/messages</id> <updated>2011-07-08T01:14:21-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> <link href="/services/messages/_new" rel="create"/> ... opensearch elements elided ... <s:messages/>
messages/{name} GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/messages/message
XML Response
. . . <title>messages</title> <id>https://localhost:8089/services/messages</id> <updated>2011-07-08T01:14:21-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> <link href="/services/messages/_new" rel="create"/> ... opensearch elements elided ... <s:messages/> <entry> <title>message</title> <id>https://localhost:8089/services/messages/message</id> <updated>2011-07-08T01:14:21-07:00</updated> <link href="/services/messages/message" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/messages/message" rel="list"/> <link href="/services/messages/message" rel="remove"/> <content type="text/xml"> <s:dict> ... eai:acl node elided ... <s:key name="eai:attributes"> <s:dict> <s:key name="optionalFields"> <s:list/> </s:key> <s:key name="requiredFields"> <s:list/> </s:key> <s:key name="wildcardFields"> <s:list/> </s:key> </s:dict> </s:key> <s:key name="message">hello world</s:key> </s:dict> </content> </entry>
server/control GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/control
XML Response
. . . <title>server-control</title> <id>https://localhost:8089/services/server/control</id> <updated>2011-07-12T00:17:53-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> <link href="/services/server/control/restart" rel="restart"/> ... opensearch elements elided ... <s:messages/>
server/control/restart POST
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/control/restart -X POST
XML Response
. . . <title>server-control</title> <id>https://localhost:8089/services/server/control</id> <updated>2014-08-05T13:02:50-07:00</updated> <generator build="221120" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/services/server/control/restart" rel="restart"/> <link href="/services/server/control/restart_webui" rel="restart_webui"/> ... opensearch nodes elided ... <s:messages/>
server/control/restart_webui POST
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/control/restart_webui -X POST
XML Response
. . . <title>server-control</title> <id>https://localhost:8089/services/server/control</id> <updated>2014-08-05T12:10:37-07:00</updated> <generator build="221120" version="6.2"/> <author> <name>Splunk</name> </author> <link href="/services/server/control/restart" rel="restart"/> <link href="/services/server/control/restart_webui" rel="restart_webui"/> ... opensearch elements elided ... <s:messages/>
server/logger GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/logger
XML Response
. . . <title>logger</title> <id>https://mrt:8089/services/server/logger</id> <updated>2011-05-16T20:29:38-0700</updated> <generator version="98144"/> <author> <name>Splunk</name> </author> ... opensearch elements elided ... <s:messages/> <entry> <title>AdminHandler:AuthenticationHandler</title> <id>https://mrt:8089/services/server/logger/AdminHandler%3AAuthenticationHandler</id> <updated>2011-05-16T20:29:38-0700</updated> <link href="/services/server/logger/AdminHandler%3AAuthenticationHandler" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/logger/AdminHandler%3AAuthenticationHandler" rel="list"/> <link href="/services/server/logger/AdminHandler%3AAuthenticationHandler" rel="edit"/> <content type="text/xml"> <s:dict> <s:key name="eai:acl">... elided ...</s:key> <s:key name="level">WARN</s:key> </s:dict> </content> </entry> . . . elided . . . <entry> <title>Application</title> <id>https://mrt:8089/services/server/logger/Application</id> <updated>2011-05-16T20:29:38-0700</updated> <link href="/services/server/logger/Application" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/logger/Application" rel="list"/> <link href="/services/server/logger/Application" rel="edit"/> <content type="text/xml"> <s:dict> <s:key name="eai:acl">... elided ...</s:key> <s:key name="level">WARN</s:key> </s:dict> </content> </entry> <entry> <title>ApplicationManager</title> <id>https://mrt:8089/services/server/logger/ApplicationManager</id> <updated>2011-05-16T20:29:38-0700</updated> <link href="/services/server/logger/ApplicationManager" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/logger/ApplicationManager" rel="list"/> <link href="/services/server/logger/ApplicationManager" rel="edit"/> <content type="text/xml"> <s:dict> <s:key name="eai:acl">... elided ...</s:key> <s:key name="level">WARN</s:key> </s:dict> </content> </entry>
server/logger/{name} GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/logger/Application
XML Response
. . . <title>logger</title> <id>https://localhost:8089/services/server/logger</id> <updated>2011-07-02T15:10:44-07:00</updated> <generator version="100492"/> <author> <name>Splunk</name> </author> ... opensearch elements elided ... <s:messages/> <entry> <title>Application</title> <id>https://localhost:8089/services/server/logger/Application</id> <updated>2011-07-02T15:10:44-07:00</updated> <link href="/services/server/logger/Application" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/logger/Application" rel="list"/> <link href="/services/server/logger/Application" rel="edit"/> <content type="text/xml"> <s:dict> <s:key name="eai:acl">... elided ...</s:key> <s:key name="eai:attributes"> <s:dict> <s:key name="optionalFields"> <s:list/> </s:key> <s:key name="requiredFields"> <s:list> <s:item>level</s:item> </s:list> </s:key> <s:key name="wildcardFields"> <s:list/> </s:key> </s:dict> </s:key> <s:key name="level">WARN</s:key> </s:dict> </content> </entry>
server/logger/{name} POST
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/logger/Application -d level=INFO
XML Response
. . . <title>logger</title> <id>https://localhost:8089/services/server/logger</id> <updated>2011-07-07T00:24:02-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> <s:messages/>
server/roles GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/roles
XML Response
. . . <title>server-roles</title> <id>https://localhost:8089/services/server/roles</id> <updated>2014-04-02T12:13:07-07:00</updated> <generator build="200839" version="6.1"/> <author> <name>Splunk</name> </author> <link href="/services/server/roles/catalog_allPossible_predefined" rel="catalog_allPossible_predefined"/> ... opensearch elements elided ... <s:messages/> <entry> <title>result</title> <id>https://localhost:8089/services/server/roles/result</id> <updated>2014-04-02T12:13:07-07:00</updated> <link href="/services/server/roles/result" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/roles/result" rel="list"/> <content type="text/xml"> <s:dict> <s:key name="eai:acl"> ... elided ... </s:key> <s:key name="indexer"/> <s:key name="license_master"/> <s:key name="license_slave"/> </s:dict> </content> </entry>
server/settings GET
XML
XML Request
curl -k -u admin:changeme https://localhost:8089/services/server/settings
XML Response
XML Response
. . . <title>server-settings</title> <id>https://localhost:8089/services/server/settings</id> <updated>2011-07-08T01:56:40-07:00</updated> <generator version="102807"/> <author> <name>Splunk</name> </author> ... opensearch elements elided ... <s:messages/> <entry> <title>settings</title> <id>https://localhost:8089/services/server/settings/settings</id> <updated>2011-07-08T01:56:40-07:00</updated> <link href="/services/server/settings/settings" rel="alternate"/> <author> <name>system</name> </author> <link href="/services/server/settings/settings" rel="list"/> <link href="/services/server/settings/settings" rel="edit"/> <content type="text/xml"> <s:dict> <s:key name="SPLUNK_DB">/home/amrit/temp/curl/splunk/var/lib/splunk</s:key> <s:key name="SPLUNK_HOME">/home/amrit/temp/curl/splunk</s:key> ... eai:acl node elided ... <s:key name="enableSplunkWebSSL">0</s:key> <s:key name="host">MrT</s:key> <s:key name="httpport">8001</s:key> <s:key name="mgmtHostPort">8085</s:key> <s:key name="minFreeSpace">2000000</s:key> <s:key name="pass4SymmKey">changeme</s:key> <s:key name="serverName">MrT</s:key> <s:key name="sessionTimeout">1h</s:key> <s:key name="startwebserver">1</s:key> <s:key name="trustedIP"/> </s:dict> </content> </entry>
PREVIOUS System 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, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12
Feedback submitted, thanks!