Skip to content

Commit

Permalink
Update Long Running README and Description files (#31650)
Browse files Browse the repository at this point in the history
* Update README.md

Clarify that some instructions are only for Cortex XSOAR 6.x.

* Update README.md

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* Update Long Running README and Description files

* RN

---------

Co-authored-by: davrahami <davrahami@paloaltonetworks.com>
  • Loading branch information
ShirleyDenkberg and Ni-Knight committed Dec 26, 2023
1 parent 673f195 commit 25a2f5e
Show file tree
Hide file tree
Showing 25 changed files with 111 additions and 54 deletions.
13 changes: 9 additions & 4 deletions Packs/EDL/Integrations/EDL/EDL_description.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,14 @@ In a web browser, go to **http://<cortex-xsoar-server-address>:<listen_port>**.

**Note**: The `Listen Port` parameter is required.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the `instance.execute.external.<instance_name>` key is set to `true`. If this key does not exist, click **+ Add Server Configuration** and add the `instance.execute.external.<instance_name>` and set the value to `true`. See [this documentation](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
3. In a web browser, go to: `https://*<xsoar_address>*/instance/execute/*<instance_name>*`
1. For Cortex XSOAR 6.x only:
1. Navigate to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x only) In the **Server Configuration** section, verify that the `instance.execute.external.<instance_name>` key is set to `true`. If this key does not exist, click **+ Add Server Configuration** and add the `instance.execute.external.<instance_name>` and set the value to `true`. See [this documentation](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
2. In a web browser, go to:

- (For Cortex XSOAR 6.x) `https://*<xsoar_address>*/instance/execute/*<instance_name>*`
- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`


In Multi Tenant environments, go to `https://<cortex-xsoar-address>/acc-<account name>/instance/execute/<instance_name>/`

Expand Down Expand Up @@ -95,4 +100,4 @@ Make sure you run the ***!export-indicators-list-update*** command for the first

### Important Notes:
- If constantly using different queries for the same EDL instance through the *q* inline argument, it is recommended to use different instances of the EDL (one for each query), and set each one with a default query for better performance.
- When using the *q* inline argument, the number of exported indicators is limited to 100,000 due to performance reasons. To export more than 100,000 indicators, create a new instance of the integration with the desired Indicator Query and List Size.
- When using the *q* inline argument, the number of exported indicators is limited to 100,000 due to performance reasons. To export more than 100,000 indicators, create a new instance of the integration with the desired Indicator Query and List Size.
12 changes: 7 additions & 5 deletions Packs/EDL/Integrations/EDL/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,13 @@ In order to get the list of all available fields to search by, you can configure

To access the Export Indicators service by instance name, make sure ***Instance execute external*** is enabled.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
2. (Cortex XSOAR 6.x only) In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*. See [this documentation](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
3. In a web browser, go to:
(For Cortex XSOAR 6.x) `https://*<xsoar_address>*/instance/execute/*<instance_name>*`
(For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`
1. For Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*. See [this documentation](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
2. In a web browser, go to:

- (For Cortex XSOAR 6.x) `https://*<xsoar_address>*/instance/execute/*<instance_name>*`
- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`


### URL Inline Arguments
Expand Down
6 changes: 6 additions & 0 deletions Packs/EDL/ReleaseNotes/3_2_17.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#### Integrations

##### Generic Export Indicators Service

- Updated the Readme file for clarification.
2 changes: 1 addition & 1 deletion Packs/EDL/pack_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Generic Export Indicators Service",
"description": "Use this pack to generate a list based on your Threat Intel Library, and export it to ANY other product in your network, such as your firewall, agent or SIEM. This pack is built for ongoing distribution of indicators from XSOAR to other products in the network, by creating an endpoint with a list of indicators that can be pulled by external vendors.",
"support": "xsoar",
"currentVersion": "3.2.16",
"currentVersion": "3.2.17",
"author": "Cortex XSOAR",
"url": "https://www.paloaltonetworks.com/cortex",
"email": "",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
We recommend that you use Cortex XSOAR server rerouting when using this integration:

For Cortex XSOAR 6.x only:
1. Navigate to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
2. In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.

**Note**: The ***Listen Port*** needs to be available, which means it has to be unique for each integration instance. It cannot be used by other long-running integrations.

Expand All @@ -14,4 +15,4 @@ We recommend that you use Cortex XSOAR server rerouting when using this integrat

For example, if the request included in the `Authorization` header the value `Bearer XXX`, then the username should be set to `_header:Authorization` and the password should be set to `Bearer XXX`.

- If you are not using server rerouting as described above, you can configure an HTTPS server by providing a certificate and private key.
- If you are not using server rerouting as described above, you can configure an HTTPS server by providing a certificate and private key.
5 changes: 3 additions & 2 deletions Packs/GenericWebhook/Integrations/GenericWebhook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ The Generic Webhook integration is used to create incidents on event triggers. T
| store_samples | Store sample events for mapping (Because this is a push-based integration, it cannot fetch sample events in the mapping wizard). | False |

4. Click **Done**.
5. Navigate to **Settings > About > Troubleshooting**.
6. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
5. For Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.

You can now trigger the webhook URL:

Expand Down
6 changes: 6 additions & 0 deletions Packs/GenericWebhook/ReleaseNotes/1_0_27.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#### Integrations

##### Generic Webhook

- Updated the Readme file for clarification.
2 changes: 1 addition & 1 deletion Packs/GenericWebhook/pack_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Generic Webhook",
"description": "The Generic Webhook integration is used to create incidents on event triggers.",
"support": "xsoar",
"currentVersion": "1.0.26",
"currentVersion": "1.0.27",
"author": "Cortex XSOAR",
"url": "https://www.paloaltonetworks.com/cortex",
"email": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
- ***List Items on Individual Lines*** - For XSOAR Lists that are comma separated text, this will take all the list items and return them on a separate line, one list item per line.

We recommend that you use Cortex XSOAR server rerouting when using this integration:

For Cortex XSOAR 6.x only:
1. Navigate to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
2. In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.

**Note**: The ***Listen Port*** needs to be available, which means it has to be unique for each integration instance. It cannot be used by other long-running integrations.

Expand All @@ -18,4 +18,4 @@ We recommend that you use Cortex XSOAR server rerouting when using this integrat

For example, if the request included in the `Authorization` header the value `Bearer XXX`, then the username should be set to `_header:Authorization` and the password should be set to `Bearer XXX`.

- If you are not using server rerouting as described above, you can configure an HTTPS server by providing a certificate and private key.
- If you are not using server rerouting as described above, you can configure an HTTPS server by providing a certificate and private key.
6 changes: 6 additions & 0 deletions Packs/PublishList/ReleaseNotes/1_1_2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#### Integrations

##### Publish List

- Updated the Readme file for clarification.
2 changes: 1 addition & 1 deletion Packs/PublishList/pack_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Publish List",
"description": "The Publish List integration is used to publish XSOAR lists for external consumption.",
"support": "community",
"currentVersion": "1.1.1",
"currentVersion": "1.1.2",
"author": "landonc",
"url": "",
"email": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

We recommend that you use Cortex XSOAR server rerouting when using this integration:

For Cortex XSOAR 6.x only:
1. Navigate to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.
2. In the **Server Configuration** section, verify that the value for the ***instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add *instance.execute.external.\<INTEGRATION-INSTANCE-NAME\>* and set the value to *true*. See the following [reference article](https://xsoar.pan.dev/docs/reference/articles/long-running-invoke) for further information.

**Note**: The ***Listen Port*** needs to be available, which means it has to be unique for each integration instance. It cannot be used by other long-running integrations.

Expand Down Expand Up @@ -45,4 +46,4 @@ This is the definition of allowed commands and methods that can be executed via
"allowed_methods":["GET"]
}
]
}`
}`
6 changes: 6 additions & 0 deletions Packs/SimpleAPIProxy/ReleaseNotes/1_0_2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#### Integrations

##### Simple API Proxy

- Updated the Readme file for clarification.
2 changes: 1 addition & 1 deletion Packs/SimpleAPIProxy/pack_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Simple API Proxy",
"description": "This pack provides a simple API proxy to restrict privileges or minimize the amount of credentials issued at the API.",
"support": "community",
"currentVersion": "1.0.1",
"currentVersion": "1.0.2",
"author": "thimanshu474",
"url": "",
"email": "",
Expand Down
3 changes: 2 additions & 1 deletion Packs/TAXIIServer/Integrations/TAXII2Server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ You can add a collection description as is done in *collection1_name*, or enter

To access the TAXII service by instance name, make sure *Instance execute external* is enabled.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
In Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the *instance.execute.external* key is set to *true*. If this key does not exist, click **+ Add Server Configuration**, add the *instance.execute.external* and set the value to *true*.

### How to use HTTPS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,13 @@ You can add a collection description as is doen in `collection1_name`, or enter
## Access the TAXII Service by Instance Name
To access the TAXII service by instance name, make sure *Instance execute external* is enabled.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x only) In the **Server Configuration** section, verify that the *instance.execute.external* key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
3. You can now trigger the webhook URL:
1. In Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the *instance.execute.external* key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
4. Trigger the webhook URL:

- (For Cortex XSOAR 6) In a web browser, go to https://*<xsoar_address>*/instance/execute/*<instance_name>* .
- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`
- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`


## How to use HTTPS
Expand All @@ -48,4 +49,4 @@ To use HTTPS, a certificate and private key have to be supplied in the integrati
The integration allows the use of basic authentication in the requests.
To enable basic authentication, a user and password have to be supplied in the Credentials parameters in the integration configuration.

The server will then authenticate the requests by the `Authorization` header, expecting basic authentication encrypted in base64 to match the given credentials.
The server will then authenticate the requests by the `Authorization` header, expecting basic authentication encrypted in base64 to match the given credentials.
7 changes: 4 additions & 3 deletions Packs/TAXIIServer/Integrations/TAXIIServer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ The collections are defined by a JSON object in the following format:

To access the TAXII service by instance name, make sure ***Instance execute external*** is enabled.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
3. You can now trigger the webhook URL:
1. For Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
2. Trigger the webhook URL:
- For Cortex XSOAR 6.x: `<CORTEX-XSOAR-URL>/instance/execute/<INTEGRATION-INSTANCE-NAME>`. For example, <https://my.demisto.live/instance/execute/taxiiserver>. Note that the string instance does not refer to the name of your XSOAR instance, but rather is part of the URL.
- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ The collections are defined by a JSON object in the following format:
## Access the TAXII Service by Instance Name
To access the TAXII service by instance name, make sure ***Instance execute external*** is enabled.

1. In Cortex XSOAR, go to **Settings > About > Troubleshooting**.
2. (For Cortex XSOAR 6.x) In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
3. You can now trigger the webhook URL:
1. For Cortex XSOAR 6.x:
1. Navigate to **Settings > About > Troubleshooting**.
2. In the **Server Configuration** section, verify that the ***instance.execute.external*** key is set to *true*. If this key does not exist, click **+ Add Server Configuration** and add the *instance.execute.external* and set the value to *true*.
2. Trigger the webhook URL:

- For Cortex XSOAR 6.x: **<CORTEX-XSOAR-URL>/instance/execute/<INTEGRATION-INSTANCE-NAME>**. For example, https://my.demisto.live/instance/execute/taxiiserver. Note that the string instance does not refer to the name of your XSOAR instance, but rather is part of the URL.
(For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`

- (For Cortex XSOAR 8 or Cortex XSIAM) `https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>`

## How to use HTTPS
To use HTTPS, a certificate and private key have to be supplied in the integration configuration.
Expand All @@ -41,4 +43,4 @@ To use HTTPS, a certificate and private key have to be supplied in the integrati
The integration allows the use of basic authentication in the requests.
To enable basic authentication, a user and password have to be supplied in the Credentials parameters in the integration configuration.

The server will then authenticate the requests by the `Authorization` header, expecting basic authentication encrypted in base64 to match the given credentials.
The server will then authenticate the requests by the `Authorization` header, expecting basic authentication encrypted in base64 to match the given credentials.
9 changes: 9 additions & 0 deletions Packs/TAXIIServer/ReleaseNotes/2_0_52.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

#### Integrations

##### TAXII Server

- Updated the Readme file for clarification.
##### TAXII2 Server

- Updated the Readme file for clarification.
2 changes: 1 addition & 1 deletion Packs/TAXIIServer/pack_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "TAXII Server",
"description": "This pack provides TAXII Services for system indicators (Outbound feed).",
"support": "xsoar",
"currentVersion": "2.0.51",
"currentVersion": "2.0.52",
"author": "Cortex XSOAR",
"url": "https://www.paloaltonetworks.com/cortex",
"email": "",
Expand Down

0 comments on commit 25a2f5e

Please sign in to comment.