Splunk® Phantom (Legacy)

REST API Reference for Splunk Phantom

Splunk Phantom 4.10.7 is the final release of Splunk's Security Orchestration, Automation, and Response (SOAR) system to be called Splunk Phantom. All later versions are named Splunk SOAR (On-premises). For more information, see the Splunk SOAR (On-premises) documentation.

REST Source Control Repository

Sync a source control repository such as https://github.com/phantomcyber/playbooks.git or file:////opt/phantom/scm/git/local.


Sync an existing source control repository.



The body of your request must be a JSON object.

Key Required Type Description
pull Required Boolean Update local repository from the specified remote repository.
force Optional Boolean If set to "true" Splunk Phantom treats the remote repository as authoritative and overwrites any local changes to playbooks.
preserve Optional Boolean If set to "true" Splunk Phantom retains the local metadata for changes to playbooks. Playbooks from the community repository always have a status of Inactive. If you have set the status of a community playbook to Active locally, updating from the community repository will set its status to Inactive unless you use the preserve key.


Sync an existing source control repository by Id.

Example request
Sync source control repository Id 3. The body of the request is a JSON Object with a "pull" command. The "force" key can be used to cause the pull operation to do a more aggressive sync, discarding local changes or conflicts.

curl -k -u admin:changeme https://localhost/rest/scm/3 \
-d '{
  "pull": true,
  "force": true

Example response
A successful POST will return an array of changes that were made. Each entry has two parts. Part 1 is the type of change, either (A)dded, (D)eleted or (M)odified. Part 2 is the name of the playbook that was changed.

    ["M", "playbook1"],
    ["D", "playbook2"],
    ["M", "playbook3"],
    ["A", "playbook4"]
Last modified on 06 April, 2021
REST Severity   REST Status

This documentation applies to the following versions of Splunk® Phantom (Legacy): 4.8, 4.9, 4.10, 4.10.1, 4.10.2, 4.10.3, 4.10.4, 4.10.6, 4.10.7

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