Removing a scanner from a project

INFERENCE DEFEND

This article is meant for Inference Defend users.

ROLES AND PERMISSIONS

To complete the tasks described in this section, make sure you have the required permissions.

• Learn more about permissions in CalypsoAI

If you no longer require a specific scanner in a project, you can either disable it or remove it from a project completely.

• Learn more about scanners
• Learn how to add a scanner to a project

Disable a scanner

If you want to keep a scanner in a project but prevent it from scanning, you can disable it.

In this scenario, we are going to disable the first scanner present in the list of available scanners.

To disable a scanner:

1. Add your token and project ID values to the following sample:

   from calypsoai import CalypsoAI
   from calypsoai.datatypes import ProjectConfigScanner
   
   # Define the URL and token for CalypsoAI
   CALYPSOAI_URL = "https://www.us1.calypsoai.app"
   CALYPSOAI_TOKEN = "ADD-YOUR-TOKEN-HERE"
   
   # Initialize the CalypsoAI client
   cai = CalypsoAI(url=CALYPSOAI_URL, token=CALYPSOAI_TOKEN)
   
   # Get all scanners
   scanners = [scanner for scanner in cai.scanners.iterate()]
   
   # Disable the scanner
   cai.projects.update(
       project="ADD-YOUR-PROJECT-ID-HERE",
       scanners=[ProjectConfigScanner(id=scanners[0].id, enabled=False)]
   )

   • In cai.projects.update > scanners, make sure enabled is set to False.

2. Run the script.
   If the request is successful, you receive the None response.

   THE NONE RESPONSE

   Confirm the scanner is disabled by checking the scanner properties in the project.

   • Learn more about the None response

   RE-ENABLING A SCANNER

   To re-enable a scanner, in cai.projects.update > scanners, set enabled to True.

Remove a scanner

If you no longer require a scanner in a project, you can remove it.

REMOVING A SCANNER

Unlike disabling a scanner, if you remove a scanner from a project, you must add it to the project again if you want to use it.

• Learn how to add a scanner to a project

In this scenario, we are going to remove a scanner from a project using the project ID and scanner ID.

To remove a scanner:

1. Add your token, project ID, and scanner ID values to the following sample:

   from calypsoai import CalypsoAI
   
   # Define the URL and token for CalypsoAI
   CALYPSOAI_URL = "https://www.us1.calypsoai.app"
   CALYPSOAI_TOKEN = "ADD-YOUR-TOKEN-HERE"
   
   # Initialize the CalypsoAI client
   cai = CalypsoAI(url=CALYPSOAI_URL, token=CALYPSOAI_TOKEN)
   
   # Remove the scanner
   response = cai.client.projects.scanners.deleteScannerId(project="ADD-YOUR-PROJECT-ID-HERE",
   scannerId="ADD-YOUR-SCANNER-ID-HERE")
   
   # Print the response
   print(response.model_dump_json(indent=2))

2. Run the script.

3. Analyze the response.

   {
       "message": "Scanner removed from the project"
   }