Installing an app

Apps are packaged in .zip files that you select and install from the Apps tab.

Important: If your environment includes an integration server that also deploys apps to your SOAR Platform, make sure that no apps are duplicated. An app that is deployed using the Apps tab and deployed from the integration server can cause conflicts and unexpected behavior. If it occurs, remove the app from the integration server by using the pip uninstall command.
When you have the app .zip file on your local system, install it.
  1. If not done already, select Administrator Settings in the system menu.
  2. Select the Apps tab.
  3. Click Install.
  4. Click Select a file then search for the app .zip file on your system.
  5. When you select a file, click Upload file in the wizard.
  6. Review the package information then click Next.
  7. In the next page of the wizard, review the customizations to be installed. If any of the customizations exist in your system, installing the app upgrades those customizations.
  8. Install the app. If completed successfully, you see a success message that you can close. Afterward, you see the app's Details tab, which displays the status of the app.
  9. If there are multiple App Hosts , select which App Host to use in the App Host field. This field lists only those App Hosts that are running.
  10. As prompted by the Installation Successful message, you might need to edit the app's configuration settings. This procedure is described in Configuring an app.
  11. If you do not need to change the configuration settings, click Deploy to deploy the app.

If a problem occurs when you install or configure an app, you can access the app logs. For more information, see Apps and App Host logs.

If you want to associate an app with a different App Host after installation, undeploy the app then deploy it again with the new App Host selected.

Uninstall an app

You can uninstall an app and its customizations, also known as playbook components, which include rules, workflows, functions, scripts, and message destinations.

Click Uninstall on the app's icon. It displays all the customizations to remove and customizations that cannot be removed because they are referenced by incident data, other customizations, or another app. Click Uninstall to complete the uninstall process.

You can also review each component that is used by the app but not removed to determine whether they can be safely removed.