REST Warm standby

API endpoints for getting warm standby information.

/warm_standby_check

To determine is a Splunk SOAR (On-premises) 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 Splunk SOAR (On-premises) instance is the standby in a warm standby pair, the API will return 500.
  • If the Splunk SOAR (On-premises) instance is either the primary in warm standby pair, or if warm standby is not configured, the API will return 200.
Note: The API will return a result of 500 if used on a cluster node.
Splunk SOAR (On-premises) clusters cannot use the warm standby feature.