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

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 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 08 March, 2023
PREVIOUS
Query for Data
  NEXT
Bulk Create and Update Records

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