---
title: "Retire.js"
description: "scanner detecting the use of JavaScript libraries with known vulnerabilities"
url: https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/scanner-description/code-scanners/retirejs
slug: whitespots-wiki/appsec-portal/features/scanners/scanner-description/code-scanners/retirejs
publish_date: 2025-12-03T21:48:20.000Z
last_modified: 2025-12-03T21:48:20.000Z
---

# Retire.js

# Retire.js

**Auditor Job Name**: Retirejs\
**Auditor image:** registry.gitlab.com/whitespots-public/security-images/retirejs:4.3.1\
**AppSec Portal Importer Name**: Retire.js Scan

[Retire.js](https://github.com/RetireJS/retire.js) is a specialized tool designed to analyze **JavaScript** code for deprecated and vulnerable libraries and dependencies. It focuses on identifying outdated or known vulnerable components within JavaScript code, contributing to the enhancement of web application security.

#### Curl example

{% code overflow="wrap" %}
```
curl -X POST localhost/api/v1/scan/import/ -H "Authorization: Token a75bb26171cf391671e67b128bfc8ae1c779ff7b" -H "Content-Type: multipart/form-data" -F "file=@./retirejs.json" -F "product_name=Product1" -F "product_type=Application" -F "scanner_name=Retire.js Scan" -F "branch=dev" -F "repository=git@gitlab.com:whitespots-public/appsec-portal.git"
```
{% endcode %}

In this command, the following parameters are used:

1. `-X POST`: specifies the HTTP method to be used (in this case, POST)
2. `-H "Authorization: Token <authorization_token>"`: specifies the [**authorization token**](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/importing-reports-from-scanners-to-appsec-portal#authorization-token) obtained from AppSec Portal.
3. `-H "Content-Type: multipart/form-data"`: specifies the content type of the request.
4. `-F "file=@<report_file_path>"`: specifies the **path to the report file** generated by the scanner.
5. `-F "product_name=<product_name>"`: specifies the **name of the product** being scanned.
6. `-F "product_type=<product_type>"`: specifies the **type of the product** being scanned.
7. `-F "scanner_name=<scanner_name>"`: specifies the **name of the scanner** used to generate the report (Retire.js Scan)
8. `-F "branch=<branch_name>"`: (_optional_) specifies the name of the branch in the source code repository (if applicable) This parameter is particularly useful when you want to associate the scan results with a specific branch in your repository. If not provided, the scan will be associated with the default branch

Asset information, if an [auditor](https://whitespots.io/docs/whitespots-wiki/auditor) is used

9. `-F "repository=<repository SSH URL>"`: If your product is **code** in a repository enter the address of your **repository** in a specific format, for example: git@gitlab.com:whitespots-public/appsec-portal.git
10. &#x20;`-F "docker_image=<registry address>"`: If your product is **image** enter the address of the **registry** where your product is located, for example: registry.gitlab.com/whitespots-public/appsec-portal/back/auto\_validator:latest
11. `-F "domain=<domain>"`: If your product is **web** enter the **domain name** of your product, for example: whitespots.io
12. `-F "host=<host>"`: If your product is **web** enter the **IP address** of your product, for example: 0.0.0.0

```json
{
    "version":"4.3.1",
    "start":"2023-12-26T14:29:58.172Z",
    "data":[],
    "messages":[],
    "errors":[],
    "time":0.201
}
```

---

## Navigation

- Location: [Docs](https://whitespots.io/docs) > [Whitespots Wiki](https://whitespots.io/docs/whitespots-wiki) > [AppSec Portal](https://whitespots.io/docs/whitespots-wiki/appsec-portal) > [🎯 Features](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features) > [🔬 Scanners](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners) > [Scanner description](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/scanner-description) > [Code Scanners](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/scanner-description/code-scanners)
- Previous: [PHPCodeSniffer](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/scanner-description/code-scanners/phpcodesniffer)
- Next: [Semgrep](https://whitespots.io/docs/whitespots-wiki/appsec-portal/features/scanners/scanner-description/code-scanners/semgrep)