Manage ISM

Manage your Veracode Internal Scanning Management (ISM) gateways and endpoints.

Update an endpoint

Update an endpoint to the latest version, change the proxy settings or Java home. You can also update an endpoint from the command line.

The Endpoints table displays the endpoint version. From the Version column, you can view the updates included in the latest endpoint versions.

To complete this task:

1. Stop the endpoint service on the server where the endpoint is installed.
2. Sign in to the Veracode Platform.
3. From the gear icon , select Internal Scanning Management.
4. Select the name link of the gateway for which you want to update an endpoint.
5. Select Actions > Set Up in the endpoint row.
6. To download the ZIP file containing the endpoint installer, select Download.
7. Move the downloaded ZIP file to a machine behind your firewall with access to your internal applications or REST APIs.
8. To copy the endpoint key to your clipboard, select Copy.
9. Run the endpoint installer. On Linux, run sudo -s ./veracode_ism_install.sh
10. To update your endpoint to the latest version, select Next.
11. To change your Java home to a different Java version, select the new location, then select Next.
12. To update your proxy settings, select Manual configuration and enter your proxy details, then select Next.
13. Select Next on the Endpoint Key page.
14. Select Install on the Summary page.
15. After updating the endpoint, select Close.
16. If you configured a proxy, configure the proxy exclusion list.

Add an endpoint to a gateway

After creating a gateway, you must add one endpoint to it. After you configure the gateway, you can add more endpoints to it. We recommend installing one endpoint in each network in which you scan your internal applications or APIs.

note

ISM currently supports ASCII characters, not UTF-8, for the names and descriptions of gateways and endpoints.

Before you begin:

Before installing an endpoint on a machine, verify that you can connect to the applications you want to scan from that machine.

To complete this task:

1. From the gear icon at the top of the Veracode Platform, select Internal Scanning Management.

2. Select the name of the gateway to which you want to add the endpoint.

3. On the gateway page, select Add Endpoint.

4. Enter the endpoint name and description.

5. Select the platform of the machine running the endpoint. For platforms other than Windows or Linux, select Other and install an endpoint from the command line.

6. Select Next.

7. Install the endpoint. After installing the endpoint, it appears on the gateway page with a status of Ready.

8. If you configured a proxy, configure the proxy exclusion list.

9. Configure a new or existing analyses to use the gateway and endpoint for internal scanning.

   • DAST
     • Web applications
     • API specifications
   • Dynamic Analysis
     • Web application
     • API specification

Edit an endpoint

After you create an endpoint, you can edit the endpoint name and description.

To complete this task:

1. From the gear icon at the top of the Veracode Platform, select Internal Scanning Management.
2. Select the name of the gateway for which you want to edit an endpoint.
3. From the Endpoints table, select the Actions menu for the endpoint you want to edit and select Edit.
4. Edit the Endpoint Name or Description field and select Save.

Manage endpoint access

Control whether your endpoints are accessible to the Veracode Platform cloud for security scanning and to receive support from Veracode Technical Support.

By default, Scan Access is enabled and Veracode Support Engineer Access is disabled.

To complete this task:

1. From the gear icon at the top of the Veracode Platform, select Internal Scanning Management.

2. Select the name of the gateway for which you want to edit the endpoint access.

3. In the Endpoints table, open the Actions menu for the endpoint you want to update and select Manage Access.

4. To enable or disable Veracode scan access to your endpoint, select Scan Access.

   Important

   Disabling scan access while scans are in progress terminates those scans.

5. To enable or disable Veracode support engineer access to your endpoint, select Veracode Support Engineer Access.

   note

   Disabling Veracode support engineer access while engineers are providing support interrupts that support.

6. If you enable Veracode support engineer access, select the access window. You can enable access for a specific number of days, up to 30, or enable it indefinitely.

7. Select Save.

Delete a gateway

If you created a gateway in error or have stopped using it, you can delete it from your ISM configuration.

Before you begin:

• Ensure you have deleted the endpoints connected to it.
• If you allowed the gateway IP address, we recommend removing it from your network allowlist.

To complete this task:

1. From the gear icon at the top of the Veracode Platform, select Internal Scanning Management.
2. Select the name of the gateway you want to delete.
3. Select Delete Gateway.
4. In the Delete window, select Delete.

Delete an endpoint

If you created an endpoint in error or have stopped using it, you can delete it from your ISM configuration.

To complete this task:

1. From the gear icon at the top of the Veracode Platform, select Internal Scanning Management.
2. Select the name of the gateway from which you want to delete the endpoint.
3. From the Endpoints table, select the Actions menu for the endpoint you want to edit and select Delete Endpoint.
4. In the Delete window, select Delete.

Uninstall an endpoint

If you no longer want to use an endpoint for scanning, you can uninstall it from your machine.

Important

Uninstalling an endpoint stops all scans currently using the endpoint.

To complete this task:

1. Navigate to the installation folder specified during the endpoint installation. The default destination is C:\Program Files\Veracode\ISM.

2. Open the uninstall folder.

3. Open the uninstall file.

   • On Windows, the filename is uninstall.bat.
   • On Linux, the filename is uninstall.sh.

4. Select Uninstall.

5. When the endpoint successfully uninstalls, select Close.

Event notifications

We send email notifications to your Security Leads for the following significant events that affect your gateway or endpoints.

Event	Notification message
Your gateway goes offline.	Due to a technical issue, your gateway and its associated endpoints are offline. Veracode Support Engineers are working to fix the issue. Veracode will send you an email when the gateway and endpoints return online. URL scans using this gateway cannot complete while the gateway is offline. View the status of the gateway in the Veracode Platform.
Your gateway comes back online.	If you had an analysis in progress when the gateway went offline, you need to restart them now. View the status of the gateway in the Veracode Platform.
An endpoint goes offline.	URL scans using this endpoint cannot complete while the endpoint is offline. If you had an analysis in progress, you will need to restart them when the endpoint is back online. View the status of your endpoints in the Veracode Platform. To get your endpoint back online, view the troubleshooting guidance in the Veracode Help Center.
An endpoint comes back online.	If you had an analysis in progress when the endpoint went offline, you need to restart them now. View the status of the endpoint in the Veracode Platform.
Your endpoint is unstable.	One of your Veracode Internal Scanning Management (ISM) endpoints is unstable, repeatedly switching between online and offline. View the current status of your endpoint in the Veracode Platform. This instability might impact analyses that are in progress. Check on the connection between your network and the machine running the endpoint. If the connection is consistent and the endpoint remains unstable, contact Veracode Technical Support at [email protected]. Your notifications for this endpoint will resume if the endpoint status changes again after 24 hours.