IBM Security SOAR

Expand all | Collapse all

API Reference for SOAR in-product scripting

  • 1.  API Reference for SOAR in-product scripting

    Posted Mon June 14, 2021 06:05 AM
    Hello All,

    In an effort to improve the experience of writing in-product Python 3 scripts for SOAR, we have put together some supplementary documentation detailing all of the fields and methods available for each object type within an in-product script, along with some example scripts and use cases. This content is not a replacement for the Official SOAR scripting documentation, but is meant to give more technical detail and examples.

    You can find the new API reference material here, be sure to bookmark as we will hopefully be adding more material over time. https://github.com/ibmresilient/resilient-scripts/tree/master/python3

    For each object type, there is a readme page where you will see a list of supported methods:
    You will also see a list of supported fields:

    For all methods, including helper methods, an example is included that can easily be copied to your clipboard:

    We hope this documentation is helpful, if you have any feedback or want to provide some of your own examples please let me know, i'd be happy to help.


    ------------------------------
    Sean Mc Cann
    ------------------------------


  • 2.  RE: API Reference for SOAR in-product scripting

    Posted Tue June 15, 2021 08:00 AM
    Thanks, Sean/Team!

    I've been looking for something like this for a while now. This will be extremely helpful!

    ------------------------------
    Thanks,
    Gareth
    ------------------------------



  • 3.  RE: API Reference for SOAR in-product scripting

    Posted Wed June 16, 2021 08:53 AM
    Nice work! Always good to see more documentation and examples published from the team.

    ------------------------------
    Jared Fagel
    Cyber Security Analyst I
    Public Utility
    ------------------------------



  • 4.  RE: API Reference for SOAR in-product scripting

    Posted Thu June 17, 2021 05:08 AM
    Edited by Robert Doerge Thu June 17, 2021 05:14 AM