Migration Guide from SOAP to REST
As the REST configuration provides data collection support and all existing functionality using new REST custom commands and alert actions, Splunk best practice is to migrate existing custom commands and alert actions from SOAP to REST.
Users need to configure a new REST Account on the REST Account Page, using the steps mentioned in the Set up the add-on.
Below are the list of new custom commands which can be used in place of existing commands:
Existing SOAP Command | New REST Command |
---|---|
remedyincidentcreate | remedyincidentcreaterest |
remedyincidentcreatestream | remedyincidentcreatestreamrest |
remedyincidentupdate | remedyincidentupdaterest |
remedyincidentupdatestream | remedyincidentupdatestreamrest |
Details regarding each custom command can be found on Commands Page.
Below are the details of of the new alert action which can be used in place of existing alert actions:
Existing SOAP Alert Action | New REST Alert Action |
---|---|
Remedy Incident Integration | Remedy Incident Integration using REST API |
remedy_incident | remedy_incident_rest |
Details regarding the new alert action can be found on Use Custom Alert Actions.
Below are the details of the new endpoint which can be used in place of the existing endpoint:
Existing SOAP Endpoint URL | New REST Endpoint URL |
---|---|
/remedy_incident | /remedy_incident_rest |
Details regarding the new endpoint can be found on Get_Incident_Details_using_a_Correlation-ID.
Field Mapping between SOAP and REST Services | Performance benchmark for custom commands |
This documentation applies to the following versions of Splunk® Supported Add-ons: released
Feedback submitted, thanks!