Reference
Product Documents
The product documents and additional information are located in IBM Documentation. (This link takes you to a page where you can choose the version of the SOAR platform.)
- Playbook Designer Guide. This guide provides the information to create and maintain playbooks.
- System Administrator Guide. This guide provides the information an IT administrator needs to configure the SOAR platform within your environment such as configuring the network, inbound email server, and threat source settings. It also provides the procedures to install apps, create and maintain users, groups, and roles, and more.
- User Guide. This guide provides information for the response team to manage incidents and tasks.
- App Host Deployment Guide. Provides the procedures to install and deploy App Hosts.
- App Developer’s Guide. Provides the procedures to develop Python-based apps using the SOAR SDK.
- Integration Server Guide. Provides the information to install and configure an integration server, which is required to deploy custom threat services and apps in the previous (non-container) format.
REST API Documents
The REST API documents are available within the SOAR platform. Open the Help/Contact menu to access.
- REST API Reference. This guide provides reference material for interacting with the REST API.
- Interactive REST API. This tool provides developers interactive access to the IBM SOAR REST API.
Communities and Other Resources
- Script examples. Example scripts and rules for use in SOAR playbooks.
- IBM Security Community Apps repository on GitHub. Provides access to library modules, community-provided apps, example scripts, and developer documentation. It also contains the SOAR SDK and Resilient Circuits.
- IBM Security App Exchange. Provides access to the SOAR community apps on IBM X-Force. You must have an account to download apps.
- IBM Security Partner Ecosystem. Introduction to IBM Security and the IBM Security App Exchange.
- IBM Security Community. Latest news, announcements and event information, plus discuss ideas and problems with other developers.
Python Related Information
- SOAR SDK. SDK available on the PyPI web site.
- Resilient Circuits. Resilient Circuits framework available on the PyPI web site.
- cert-chain-resolver.py Python script. Used to fetch intermediate certificates, using the AIA (Authority Information Access) information that is embedded within the certs.
IBM Security SOAR Platform Software for Integration Partners
IBM technology partners can gain access to SOAR platform software for development and testing, co-marketing opportunities, and many additional resources.
- IBM PartnerWorld Software Access Catalog. Use your IBM PartnerWorld Software Access Catalog subscription to download the On-Premises edition of the SOAR platform.
- IBM Security Early Release Programs. If you have been given an Access Key for IBM Security Early Release Programs, you can download software and trial licenses.