# API Pull

All parsers that use API pull have common basic configuration steps, but with different values.

Follow these steps to set up API importing:

## Tool Configuration

1. Configure the API authentication details by navigating to  
   `Configuration -> Tool Configuration -> Add Tool Configuration`. Enter a `Name`,  
   selecting the related `Tool Type` and `Authentication Type` “API Key”. Paste your credentials  
   into the proper fields based on the selected parser.

## Product-Level Configuration

1. Navigate to `Products -> All Products` and select a product from the list.

2. Click on `Settings` and select `Add API Scan Configuration`

3. Select the previously added `Tool Configuration` and provide additional values based on the selected parser.

4. After this is done, you can import the findings on the `Product` page through  
   `Findings -> Import Scan Results`. As the `Scan type`, select the related type  
   (the `API Scan Configuration` created above) and click `Import`.

## Custom Trust

In some cases, you may want to connect to a tool that uses a certificate from a certification authority (CA) that is not  
in the default trust store (e.g. a company-internal CA), which requires that you add custom trust to an existing trust  
store or replace the existing trust store with your own.

### Using a Custom-Built DefectDojo Image

When you are building your own container image for `django-DefectDojo`, you can simply add the certificates you would  
like to include as custom trust to the `docker/certs` path.

### Using the Prebuilt DefectDojo Image

1. Create a new mounted volume where the new trust store will be added (ensures persistence).
2. Create a new trust store
   1. Prepare a new PEM-encoded trust store file (`custom-cacerts.pem`).
   2. Optional, if you want to keep existing trust: Add the custom trust to the existing trust store
      1. Find the location of the existing trust store by running `python -m certifi` in the container.
      2. Append your custom trust to the existing trust store by running  
         `cat cacert.pem custom-cacerts.pem > extended-cacerts.pem`.

_**Important: The consequence of copying the existing trust store is that you will not receive any updates**_
         _**(added or removed CA certificates).**_
3. Copy the new trust store (`custom-cacerts.pem` or `extended-cacerts.pem`) to the mounted volume.
4. Point the environment variable `REQUESTS_CA_BUNDLE` to the new trust store file.

> `REQUESTS_CA_BUNDLE` is an environment variable from the Python `requests` package. By default, it uses the trust  
> store provided by the `certifi` package. For more details, check the respective documentation.