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:

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 username:password 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 17 February, 2023
REST Vault   REST Workbook

This documentation applies to the following versions of Splunk® SOAR (On-premises): 6.0.0, 6.0.1, 6.0.2, 6.1.0, 6.1.1, 6.2.0, 6.2.1, 6.2.2, 6.3.0

Acrobat logo Download manual
Acrobat logo Download this page

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