REST API

The SOAR Platform has a full-featured REST API that sends and receives JSON formatted data. It has complete access to almost all features, including but not limited to: creating and updating incidents and tasks, managing users and groups, and creating artifacts and attachments. Custom behaviors are triggered by adding a message destination to a rule, workflow or function defined in the SOAR Platform and subscribing your code to that message destination.

The SOAR Platform contains an interactive Rest API browser that allows you to access the REST API and try out any endpoint on the system. When logged into the SOAR Platform, click on your account name at the top right and select Help/Contact. Here you can access the complete API Reference guide, including schemas for all of the JSON sent and received by the API, and the interactive Rest API.