Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

As of version 6.4.0, the visual editor for classic playbooks is no longer part of Splunk SOAR. Before upgrading, convert your classic playbooks to modern mode. Your classic playbooks will continue to run and you can view and edit them in the SOAR Python code editor.
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 Warm standby

API endpoints for getting warm standby information.

/warm_standby_check

To determine is a instance is part of a warm standby configuration an HTTP GET is made to /warm_standby_check.

Syntax 

https://<username>:<password>@<host>/warm_standby_check

GET

Warm standby check

Example request
Check to see if an instance is configured as the standby in a warm standby pair. 

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

Example response
A successful GET will return either 500 or 200.

  • If the instance is the standby in a warm standby pair, the API will return 500.
  • If the instance is either the primary in warm standby pair, or if warm standby is not configured, the API will return 200.

The API will return a result of 500 if used on a cluster node.

clusters cannot use the warm standby feature.
Last modified on 08 March, 2023
REST Vault   REST Workbook

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

Acrobat logo Download manual
Acrobat logo Download this page

Please expect delayed responses to documentation feedback while the team migrates content to a new system. We value your input and thank you for your patience as we work to provide you with an improved content experience!

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