Skip to content

Commit 2cd29a6

Browse files
authored
docs: Update README.md
1 parent a1e2723 commit 2cd29a6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ docker run -it -rm -p 5000:5000 ghcr.io/l4rm4nd/cvss-api:latest
1313
Afterwards, you can utilize the API server:
1414

1515
````
16+
# query CVSS 2.0 vector
1617
curl "http://127.0.0.1:5000/cvss?vector=CVSS:2.0/AV:N/AC:L/Au:N/C:C/I:C/A:C"
18+
# query CVSS 3.1 vector
1719
curl "http://127.0.0.1:5000/cvss?vector=CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H"
20+
# query CVSS 4.0 vector
1821
curl "http://127.0.0.1:5000/cvss?vector=CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N"
1922
````
2023

21-
The API will respond with the following JSON:
24+
The API will respond with the following example JSON:
2225

2326
````
2427
{
@@ -29,3 +32,8 @@ The API will respond with the following JSON:
2932
````
3033

3134
Combine with an TLS reverse proxy. CORS is already allowed on the Flask application.
35+
36+
> [!TIP]
37+
> For CVSS 4.0, the API server defines `Subsequent System Impact Metrics` as optional.
38+
>
39+
> Therefore, you can neglect `SC`, `SI` and `SA` from your provided vector string. The backend will automatically set those to `N` (None).

0 commit comments

Comments
 (0)