Splunk® SOAR (On-premises)

Build Playbooks with the Playbook Editor

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Save a playbook so can access it

You must save a playbook before can access it. If errors exist in the playbook or the underlying code, an error message is displayed with additional information. If there are any parent playbooks associated with the playbook, a message will appear listing the playbooks the save might affect. You can't save a playbook until you resolve all errors.

Save a playbook for the first time

Perform the following tasks to save a playbook for the first time.

  1. Click Save to begin saving a playbook.
  2. Enter a brief comment for the playbook, such as a description of what the playbook does.
  3. (Optional) Click Reuse this comment until the editor is reloaded if you want to use the same comment each time you save the playbook during this editing session.
  4. Click Save to save the playbook.

Save a copy of a playbook

Perform the following tasks to create a copy of a playbook.

  1. Open any existing playbook for editing.
  2. Click the vertical ellipsis icon and click Save As.
  3. Enter a new name for the playbook.
  4. Enter a brief comment for the playbook's revision history, such as a description of what has changed.
  5. (Optional) Click Reuse this comment until the editor is reloaded if you want to use the same comment each time you save the playbook during this editing session.
  6. Click Save.

Export and import a playbook

Perform the following tasks to export a playbook. The playbook is exported as a JSON file to your local filesystem.

  1. Open any existing playbook for editing.
  2. Click the vertical ellipsis icon and click Export.

Perform the following tasks to import and create a new playbook.

  1. From the main menu, select Playbooks.
  2. Click the Import playbook icon.
  3. Select a target repository from the source to update drop-down menu.
  4. Drag and drop your .tgz playbook file that was exported previously, or click click here and select the playbook on your file system.
  5. Click Upload.
Last modified on 19 October, 2021
PREVIOUS
Determine your playbook flow in
  NEXT
Use keyboard shortcuts in the playbook editor

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


Was this documentation topic helpful?


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