Splunk® SOAR (On-premises)

Develop Apps for Splunk SOAR (On-premises)

The visual editor for classic playbooks was removed from Splunk SOAR in release 6.4.0. 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:

Optional: Set up a development environment for

It is a good practice to develop your apps in a separate environment than your production deployment.

For instructions on how to install Splunk SOAR (On-premises), see How can Splunk SOAR (On-premises) be installed?.

Set up the dev environment

Once the virtual machine image file is downloaded, you must load it in your virtual machine software of choice, then set both the root and user passwords. Remote root login is disabled, so you need to use SSH as the user account the use sudo to get root access.

The firewall is pre-configured to allow SSH connections.

SSH to Splunk SOAR

localmachine:~ alice$ ssh user@192.0.2.255
user@192.0.2.255's password:
[user@localhost ~]$ sudo su -
[sudo] password for user:
[root@localhost ~]#

Set the hostname

Optionally, you can set the hostname of the virtual machine to make accessing it easier:

[root@localhost ~]# hostname appdev
[root@localhost ~]#

User 'phantom'

It's good practice to use a non-root user for app development. The user phantom is already created for your deployment and can be used for this purpose. You should set a password for this user account.

Set the password for the user phantom:

[root@localhost ~]# passwd phantom
Changing password for user phantom.
New password:
Retype new password:
passwd: all authentication tokens updated successfully.
[root@localhost ~]# 

Exit and login as phantom.

[root@localhost ~]# exit
logout
[user@localhost ~]$ exit
logout
Connection to 192.0.2.255 closed.
mymbp:~ alice$ ssh phantom@192.0.2.255
phantom@192.0.2.255's password:
[phantom@appdev ~]$
Last modified on 19 December, 2022
Splunk SOAR apps overview   Create an app with the App Wizard

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.5.0, 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, 6.3.1, 6.4.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