Skip to main content
Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

Splunk® SOAR (On-premises)
6.0.2
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 System Settings

Update a subset of system settings such as the authentication providers.

/rest/system_settings

Update authentication providers.

Syntax

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

POST

Expand

Update the authentication provider settings by replacing the entire configuration or by replacing parts of it.

/rest/system_settings/features

Enable or disable system settings features.

Syntax

https://<username>:<password>@<host>/rest/system_settings/features

Usage details
The system setting edit permissions are required to change this setting.

POST

Expand

Enable system settings features.

/rest/system_settings/events

Create or delete custom labels.

Syntax

https://<username>:<password>@<host>/rest/system_settings/events

Usage details
The system setting edit permissions are required to change this setting.

POST

Expand

Create a label.

POST

Expand

Delete a label.

/rest/system_settings/labels

Return a list of container labels setup information from label settings in Splunk SOAR (On-premises).

Syntax

https://<username>:<password>@<host>/rest/system_settings/labels

GET

Expand

Return a list of container labels setup information from label settings in Splunk SOAR (On-premises).

/rest/system_settings optional query parameters

/rest/system_settings?sections

Get the status of feature system settings sections.

Syntax

https://<username>:<password>@<host>/rest/system_settings?sections

GET

Expand

Get the status of system settings.

Last modified on 18 October, 2024
REST Status   REST User

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


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