Vulnerability-Lookup

https://www.vulnerability-lookup.org
Admin
Vulnerability-Lookup is a collaborative platform designed to facilitate the rapid correlation of...
Tokens:75,117
Snippets:1,101
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup PostgreSQL Database

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Installs PostgreSQL and creates the required user and database.

```bash
sudo apt install postgresql
sudo -u postgres createuser -P <username>
Enter password for new role: <password>
sudo -u postgres createdb <database> -O <username>
```

--------------------------------

### Start all services

Source: https://www.vulnerability-lookup.org/documentation/_sources/command-line-interface.md

Initializes all project services.

```bash
$ poetry run start
```

--------------------------------

### Install Dependencies and Initialize Environment

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Installs project dependencies and sets the home directory environment variable.

```bash
poetry install
```

```bash
echo VULNERABILITYLOOKUP_HOME="$(pwd)" >> .env
```

--------------------------------

### Install VulnMCP

Source: https://www.vulnerability-lookup.org/user-manual/ai

Clone the repository and install dependencies using Poetry.

```bash
git clone https://github.com/vulnerability-lookup/VulnMCP.git
cd VulnMCP
poetry install
```

--------------------------------

### Install Meilisearch locally

Source: https://www.vulnerability-lookup.org/documentation/_sources/fulltextsearch.md

Downloads and installs the latest stable Meilisearch release using curl.

```bash
sudo apt-get update
sudo apt install curl -y
curl -L https://install.meilisearch.com | sh
```

--------------------------------

### Manage website service

Source: https://www.vulnerability-lookup.org/documentation/_sources/command-line-interface.md

Starts or restarts the website service.

```bash
$ poetry run start_website
```

```bash
$ poetry run restart_website
```

--------------------------------

### Start backend and website services

Source: https://www.vulnerability-lookup.org/documentation/minimal-publication.html

Initializes the backend services and the website using poetry.

```bash
poetry run run_backend --start
poetry run start_website
```

--------------------------------

### GET /user/setup-2fa

Source: https://www.vulnerability-lookup.org/documentation/_sources/webservice.md

Endpoint to set up two-factor authentication.

```APIDOC
## GET /user/setup-2fa

### Description
Set-up TFA with QRCode (or token) provided by the server.

### Method
GET

### Endpoint
/user/setup-2fa
```

--------------------------------

### Manage feeders

Source: https://www.vulnerability-lookup.org/documentation/_sources/command-line-interface.md

Starts or stops all enabled feeders.

```bash
$ poetry run feeders_manager --start
$ poetry run feeders_manager --stop
```

--------------------------------

### Manage Application Lifecycle

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Use these commands to start, stop, or update the application from the project directory.

```bash
poetry run start
```

```bash
poetry run stop
```

```bash
poetry run update
```

--------------------------------

### Start and stop services

Source: https://www.vulnerability-lookup.org/documentation/command-line-interface.html

Commands to manage the lifecycle of the project services.

```bash
$ poetry run start
```

```bash
$ poetry run stop
```

--------------------------------

### Install Meilisearch for Systemd

Source: https://www.vulnerability-lookup.org/documentation/_sources/fulltextsearch.md

Downloads and moves the binary to the system path for service management.

```bash
sudo apt-get update
sudo apt install curl -y
curl -L https://install.meilisearch.com | sh
mv ./meilisearch /usr/local/bin/
```

--------------------------------

### Manage backend services

Source: https://www.vulnerability-lookup.org/documentation/_sources/command-line-interface.md

Starts or stops Valkey and Kvrocks backend services.

```bash
$ poetry run run_backend --start
$ poetry run run_backend --stop
```

--------------------------------

### Install Valkey Dependencies

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

System packages required to build Valkey from source.

```bash
sudo apt-get update
sudo apt install build-essential tcl
```

--------------------------------

### Run Meilisearch binary

Source: https://www.vulnerability-lookup.org/documentation/_sources/fulltextsearch.md

Starts the Meilisearch instance using a specific configuration file.

```bash
./meilisearch --config-file-path="./config.toml"
```

--------------------------------

### Manage systemd service

Source: https://www.vulnerability-lookup.org/documentation/_sources/notification.md

Commands to reload, enable, and start the notification service.

```bash
sudo systemctl daemon-reload
sudo systemctl enable vulnerability-lookup-notify.service
sudo systemctl start vulnerability-lookup-notify.service
systemctl status vulnerability-lookup-notify.service
```

--------------------------------

### Launch notification service with poetry

Source: https://www.vulnerability-lookup.org/documentation/_sources/notification.md

Command to start the watchlist notification service using poetry.

```bash
poetry run flask --app website.app notify_users
```

--------------------------------

### Example Inference Output

Source: https://www.vulnerability-lookup.org/user-manual/ai

Sample output generated by the severity classification model.

```text
Predictions: tensor([[2.5910e-04, 2.1585e-03, 1.3680e-02, 9.8390e-01]])
Predicted severity: critical
```

--------------------------------

### Set up development environment

Source: https://www.vulnerability-lookup.org/documentation/_sources/contributing.md

Commands to clone the repository, install dependencies via Poetry, and initialize pre-commit hooks.

```bash
git clone --recursive https://github.com/vulnerability-lookup/vulnerability-lookup.git
cd vulnerability-lookup/
poetry install --with dev
pre-commit install
```

--------------------------------

### GET /api/stats/vulnerability/most_sighted

Source: https://www.vulnerability-lookup.org/2025/10/24/workshop-at-hack-lu-2025

Retrieves the most sighted vulnerabilities.

```APIDOC
## GET /api/stats/vulnerability/most_sighted

### Description
Returns the most sighted vulnerabilities within a specific timeframe.

### Method
GET

### Endpoint
https://vulnerability.circl.lu/api/stats/vulnerability/most_sighted

### Parameters
#### Query Parameters
- **date_from** (string) - Optional - Start date for the query (YYYY-MM-DD).
- **output** (string) - Optional - The format of the output (e.g., markdown).
```

--------------------------------

### Initialize Database and Create Administrator

Source: https://www.vulnerability-lookup.org/documentation/_sources/minimal-publication.md

Run these commands to initialize the database schema and create the initial administrative user account.

```bash
poetry run flask --app website.app db_init
poetry run flask --app website.app db stamp head
poetry run flask --app website.app create_admin --login admin --email admin@example.org --password '<change-me>'
```

--------------------------------

### Initialize CNA configuration file

Source: https://www.vulnerability-lookup.org/documentation/_sources/cna.md

Copy the sample configuration file to the active configuration path.

```bash
cp config/cna.json.sample config/cna.json
```

--------------------------------

### GET /known-exploited-vulnerabilities-catalog/feed.atom

Source: https://www.vulnerability-lookup.org/documentation/feeds.html

Retrieves KEV catalog feeds.

```APIDOC
## GET /known-exploited-vulnerabilities-catalog/feed.atom

### Description
Retrieves a KEV catalog feed, optionally filtered by a specific catalog UUID.

### Method
GET

### Endpoint
https://vulnerability.circl.lu/known-exploited-vulnerabilities-catalog/feed.atom

### Parameters
#### Query Parameters
- **catalog_uuid** (string) - Optional - The UUID of the specific BCP-07 catalog.
```

--------------------------------

### GET /sightings/feed.<format>

Source: https://www.vulnerability-lookup.org/user-manual/feed-syndication

Retrieves recent sightings.

```APIDOC
## GET /sightings/feed.<format>

### Description
Retrieves recent sightings in the specified format.

### Method
GET

### Endpoint
/sightings/feed.<string:format>

### Parameters
#### Path Parameters
- **format** (string) - Required - The feed format, either 'rss' or 'atom'.

#### Query Parameters
- **vulnerability** (string) - Optional - Filter by a specific vulnerability ID.
```

--------------------------------

### Copy standard configuration files

Source: https://www.vulnerability-lookup.org/documentation/_sources/minimal-publication.md

Initialize the configuration directory by copying sample files to their active locations.

```bash
cp config/generic.json.sample config/generic.json
cp config/logging.json.sample config/logging.json
cp config/website.py.sample config/website.py
cp config/stream.json.sample config/stream.json
cp config/fulltextsearch.json.sample config/fulltextsearch.json
cp config/modules.cfg.sample config/modules.cfg
```

--------------------------------

### GET /api/system/redis_up

Source: https://www.vulnerability-lookup.org/user-manual/system-monitoring

Checks if the Redis instance is operational.

```APIDOC
## GET /api/system/redis_up

### Description
Checks if the Redis instance is operational.

### Method
GET

### Endpoint
/api/system/redis_up

### Response
#### Success Response (200)
- **status** (boolean) - Returns true if Redis is up.
```

--------------------------------

### Initialize Database

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Initializes the database schema and creates the version table.

```bash
poetry run flask --app website.app db_init             # initialize database
poetry run flask --app website.app db stamp head       # create alembic_version table
```

--------------------------------

### GET /bundles/feed.{format}

Source: https://www.vulnerability-lookup.org/documentation/_sources/feeds.md

Retrieves recent bundles.

```APIDOC
## GET /bundles/feed.{format}

### Description
Returns recent bundles.

### Method
GET

### Endpoint
/bundles/feed.{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The feed format, either 'rss' or 'atom'.

#### Query Parameters
- **user** (string) - Optional - Narrows results to one author.
```

--------------------------------

### Build Valkey from Source

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Commands to clone, checkout, and compile the Valkey repository.

```bash
git clone https://github.com/valkey-io/valkey
cd valkey
git checkout 9.0.1
make
# Optionally, run the tests:
make test
cd ..
```

--------------------------------

### GET /comments/feed.{format}

Source: https://www.vulnerability-lookup.org/documentation/_sources/feeds.md

Retrieves recent comments.

```APIDOC
## GET /comments/feed.{format}

### Description
Returns recent comments.

### Method
GET

### Endpoint
/comments/feed.{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The feed format, either 'rss' or 'atom'.

#### Query Parameters
- **user** (string) - Optional - Narrows results to one author.
```

--------------------------------

### Configure Meilisearch directories and config

Source: https://www.vulnerability-lookup.org/documentation/_sources/fulltextsearch.md

Prepares the data directories and downloads the configuration file to the system directory.

```bash
mkdir /var/lib/meilisearch/data /var/lib/meilisearch/dumps /var/lib/meilisearch/snapshots
chown -R meilisearch:meilisearch /var/lib/meilisearch
chmod 750 /var/lib/meilisearch
curl https://raw.githubusercontent.com/meilisearch/meilisearch/latest/config.toml > /etc/meilisearch.toml
```

--------------------------------

### Copy Configuration Files

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Copies sample configuration files to their active locations.

```bash
cp config/generic.json.sample config/generic.json
cp config/logging.json.sample config/logging.json
cp config/website.py.sample config/website.py
cp config/stream.json.sample config/stream.json
cp config/fulltextsearch.json.sample config/fulltextsearch.json
```

--------------------------------

### GET /api/system/checkProcess

Source: https://www.vulnerability-lookup.org/user-manual/system-monitoring

Retrieves the heartbeat timestamps for all system processes.

```APIDOC
## GET /api/system/checkProcess

### Description
Retrieves the heartbeat timestamps for all system processes.

### Method
GET

### Endpoint
/api/system/checkProcess

### Parameters
#### Request Headers
- **X-API-KEY** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **process_heartbeats** (object) - A map of process names to their last heartbeat timestamp strings.
```

--------------------------------

### GET /api/system/checkSMTP

Source: https://www.vulnerability-lookup.org/user-manual/system-monitoring

Checks the status of the SMTP notification system.

```APIDOC
## GET /api/system/checkSMTP

### Description
Checks the status of the SMTP notification system.

### Method
GET

### Endpoint
/api/system/checkSMTP

### Parameters
#### Request Headers
- **X-API-KEY** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **status** (boolean) - Returns true if SMTP is operational.
```

--------------------------------

### GET /sightings/feed.atom

Source: https://www.vulnerability-lookup.org/documentation/_sources/feeds.md

Retrieves sightings for a specific vulnerability or product.

```APIDOC
## GET /sightings/feed.atom

### Description
Retrieves aggregated sightings data.

### Method
GET

### Endpoint
https://vulnerability.circl.lu/sightings/feed.atom

### Parameters
#### Query Parameters
- **vulnerability** (string) - Optional - Filter by specific vulnerability ID
```

--------------------------------

### GET /api/sighting/

Source: https://www.vulnerability-lookup.org/documentation/_sources/api.md

Retrieve sightings for a vulnerability with pagination support.

```APIDOC
## GET /api/sighting/

### Description
Retrieves a paginated list of sightings for a specific vulnerability.

### Method
GET

### Endpoint
/api/sighting/

### Parameters
#### Query Parameters
- **vuln_id** (string) - Optional - The vulnerability ID to filter sightings.
- **page** (integer) - Optional - The page number for pagination.
- **per_page** (integer) - Optional - The number of items per page.
```

--------------------------------

### GET /api/comment/

Source: https://www.vulnerability-lookup.org/documentation/_sources/api.md

Retrieve and filter comments associated with vulnerabilities.

```APIDOC
## GET /api/comment/

### Description
Retrieves a list of comments, optionally filtered by metadata using JSONB containment.

### Method
GET

### Endpoint
/api/comment/

### Parameters
#### Query Parameters
- **meta** (string) - Optional - A JSON value matched against the comment's meta field.
```

--------------------------------

### Initialize Submodules

Source: https://www.vulnerability-lookup.org/documentation/_sources/installation.md

Updates and initializes project submodules.

```bash
git submodule update --init
```

--------------------------------

### GET /api/vulnerability/{id}

Source: https://www.vulnerability-lookup.org/documentation/_sources/api.md

Look up a specific vulnerability by its ID.

```APIDOC
## GET /api/vulnerability/{id}

### Description
Retrieves details for a specific vulnerability using its unique identifier.

### Method
GET

### Endpoint
/api/vulnerability/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The vulnerability identifier (e.g., CVE-2024-38063)
```

--------------------------------

### GET /known-exploited-vulnerabilities.atom

Source: https://www.vulnerability-lookup.org/documentation/feeds.html

Retrieves feeds related to known exploited vulnerabilities.

```APIDOC
## GET /known-exploited-vulnerabilities.atom

### Description
Retrieves the CISA KEV list feed.

### Method
GET

### Endpoint
https://vulnerability.circl.lu/known-exploited-vulnerabilities.atom
```

--------------------------------

### Initialize the Database

Source: https://www.vulnerability-lookup.org/documentation/_sources/webservice.md

Command to initialize the database using the Flask application context.

```bash
$ poetry run flask --app website.app db_init
```

--------------------------------

### Download Meilisearch configuration

Source: https://www.vulnerability-lookup.org/documentation/_sources/fulltextsearch.md

Fetches the default configuration file from the official repository.

```bash
curl https://raw.githubusercontent.com/meilisearch/meilisearch/latest/config.toml > config.toml
```

--------------------------------

### GET /sightings/feed.{format}

Source: https://www.vulnerability-lookup.org/documentation/_sources/feeds.md

Retrieves recent sightings across all vulnerabilities.

```APIDOC
## GET /sightings/feed.{format}

### Description
Returns recent sightings.

### Method
GET

### Endpoint
/sightings/feed.{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The feed format, either 'rss' or 'atom'.

#### Query Parameters
- **vulnerability** (string) - Optional - Narrows results to a single vulnerability.
```
Tokens:
Raw