Splunk® SOAR (On-premises)

REST API Reference 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:

Update Records

It is possible to update existing records using REST. Complete or partial updates can be made by doing an HTTP POST to the record ID that you want to update.

/rest/<type>/<id>

Syntax

https://<username>:<password>@<host>/rest/<type>/<id>

POST

Update an existing container.

Example request
Update container Id 10 with a new name and severity.

curl -k -u soar_local_admin:changeme https://localhost/rest/container/10 \
-d '[
{
    "name": "my new container name",
    "severity": "low"
}
]'

Example success response
A successful POST will return the success message and Id.

{
    "id": 10,
    "success": true
}

Example failure response
A failed POST will return the failure message and reason.

{
    "failed": true,
    "message": "<reason>"
}

Any record that can be created using the REST API can be updated as described.

Last modified on 15 February, 2023
Query for Data   Bulk Create and Update Records

This documentation applies to the following versions of Splunk® SOAR (On-premises): 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