Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

Acrobat logo Download manual as PDF


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.
Acrobat logo Download topic as PDF

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 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 08 March, 2023
PREVIOUS
REST Severity
  NEXT
REST Status

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, 5.3.6, 5.4.0, 5.5.0


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