Splunk® SOAR (Cloud)

REST API Reference for Splunk SOAR (Cloud)

The classic playbook editor will be deprecated soon. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:

REST Source Control Repository

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

/rest/scm/<scm_id>

Sync an existing source control repository.

Syntax

https://<username>:<password>@<host>/rest/scm/<scm_id>

POST

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 username:password 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 29 May, 2024
REST Severity   REST Status

This documentation applies to the following versions of Splunk® SOAR (Cloud): current, current


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