Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

The classic playbook editor will be deprecated in early 2025. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:
This documentation does not apply to the most recent version of Splunk® SOAR (On-premises). For documentation on the most recent version, go to the latest release.

REST Cluster Nodes

cluster information can be read via an HTTP GET request. This endpoint is read-only and does not accept HTTP POST requests. Access to this endpoint requires authentication and system settings permissions.

/rest/cluster_node

Cluster information such as node name, status, Id, version, etc.

Syntax

https://<username>:<password>@<host>/rest/cluster_node

GET

Get cluster information.

Example curl request
Get cluster information.

curl -k -u admin:changeme https://localhost/rest/cluster_node -G -X GET

Example response
A successful GET will return a JSON formatted list of key names and data.

{
    "count": 3,
    "data": [
        {
            "update_time": "2018-09-04T22:27:42.722084Z",
            "name": "1.2.3.4",
            "enabled": true,
            "server": true,
            "host": "1.2.3.4",
            "create_time": "2018-09-04T19:50:27.960889Z",
            "version": "4.0.1068",
            "online": true,
            "guid": "6c395b0f-5574-45e2-ac74-801d0ad8495c",
            "id": 3
        },
        {
            "update_time": "2018-09-04T22:28:05.027246Z",
            "name": "2.3.4.5",
            "enabled": true,
            "server": true,
            "host": "2.3.4.5",
            "create_time": "2018-09-04T19:49:18.185595Z",
            "version": "4.0.1068",
            "online": true,
            "guid": "e9ba83af-be4e-4cb9-9264-32971ef80b55",
            "id": 2
        },
        {
            "update_time": "2018-09-04T22:28:06.517752Z",
            "name": "3.4.5.6",
            "enabled": true,
            "server": true,
            "host": "3.4.5.6",
            "create_time": "2018-09-04T19:48:03.988898Z",
            "version": "4.0.1068",
            "online": true,
            "guid": "41200aa3-1e9c-4436-b77f-d9471263572f",
            "id": 1
        }
    ],
    "num_pages": 1
}
Last modified on 08 March, 2023
REST CEF   REST Containers

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.1.0, 5.2.1, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.5.0


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters