Xsoar_Utils

This is a wrapper on top of XSOAR API. Can be used to implement commands that call the XSOAR API in the background. This is mostly to avoid constructing raw json strings while calling the demisto rest api integration. The first implemented command can be used to create an entry on any investigation; playground by default. An example use-case could be debugging a pre-process script. (Call demisto.execute_command("xsoar-create-entry",{arguments}) The idea is to use the same code to test from a local machine. python3 Xsoar_Utils.py xsoar-create-entry '{"data":"# testapi4","inv_id":"122c7bff-feae-4177-867e-37e2096cd7d9"}' Read the code to understand more.

Utilities · Xsoar_Utils

Details

IDXsoar_Utils
ProviderPalo Alto Networks
CategoryUtilities
From Version6.0.0
Docker Imagedemisto/python3:3.12.8.3296088
Supported ModulesAgentix XSIAM

README

This is a wrapper on top of XSOAR API. Can be used to implement commands that call the XSOAR API in the background. This is mostly to avoid constructing raw json strings while calling the xsoar rest api integration.

The first implemented command can be used to create an entry on any investigation; playground by default. An example use-case could be debugging a pre-process script. (Call .execute_command(“xsoar-create-entry”,{arguments})

The idea is to use the same code to test from a local machine.
python3 Xsoar_Utils.py xsoar-create-entry ‘{“data”:”# testapi4”,”inv_id”:”122c7bff-feae-4177-867e-37e2096cd7d9”}’

Read the code to understand more.

Configure Xsoar_Utils in Cortex

Parameter Description Required
XSOAR Server URL   True
XSOAR Server API_Key   True
XSOAR Server playground-id   True
Allow Insecure connections to the server Check this to ignore certificate signature False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

xsoar-create-entry


Creates an entry into an investigation warroom or by default on the playground.

Base Command

xsoar-create-entry

Input

Argument Name Description Required
data Entry value to be created. Optional
inv_id The investigation id on which the entry is created. Defaults to playbook-id. Optional

Context Output

There is no context output for this command.

Command Example

``````

Human Readable Output

Configuration parameters

  • url — XSOAR SERVER URL (required)
  • apikey — XSOAR SERVER API KEY (required)
  • playground-id — XSOAR Server PLAYGROUND ID (required)
  • insecure — Trust any certificate (not secure)

Commands (1)

  • xsoar-create-entry

    Creates an entry into an investigation warroom or by default on the playground.

category: Utilities
provider: Palo Alto Networks
commonfields:
  id: Xsoar_Utils
  version: -1
configuration:
- display: XSOAR SERVER URL
  name: url
  required: true
  type: 0
- display: XSOAR SERVER API KEY
  name: apikey
  required: true
  type: 4
- display: XSOAR Server PLAYGROUND ID
  name: playground-id
  required: true
  type: 0
- additionalinfo: Check this to ignore certificate signature
  defaultvalue: 'false'
  display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
description: 'This is a wrapper on top of XSOAR API. Can be used to implement commands that call the XSOAR API in the background.  This is mostly to avoid  constructing raw json strings while calling the demisto rest api integration.


  The first implemented command can be used to create an entry on any investigation; playground by default.  An example use-case could be debugging a pre-process script. (Call demisto.execute_command("xsoar-create-entry",{arguments})


  The idea is to use the same code to test from a local machine.

  python3  Xsoar_Utils.py  xsoar-create-entry  ''{"data":"# testapi4","inv_id":"122c7bff-feae-4177-867e-37e2096cd7d9"}''


  Read the code to understand more.'
display: Xsoar_Utils
name: Xsoar_Utils
script:
  commands:
  - arguments:
    - description: Entry value to be created.
      name: data
    - description: The investigation id on which the entry is created. Defaults to playbook-id.
      name: inv_id
    description: Creates an entry into an investigation warroom or  by default on the playground.
    name: xsoar-create-entry
  dockerimage: demisto/python3:3.12.8.3296088
  runonce: false
  script: ''
  subtype: python3
  type: python
fromversion: 6.0.0
tests:
- No tests (auto formatted)