DOC.md

Vulnerability Manager API

Introduction

Vulnerability Management System API Documentation

🚩 GET /api-auth/login/

django login to access the Django REST framework

🚩 GET /api-token-auth/

Get API token

Body

  {
    "username": "test",
    "password": "***************"
  }

🚩 GET /api/assets/

• list hosts
• List hosts sorted /api/assets/?ordering=hostname

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

Order by	ascending	descending
Hostname	hostname	-hostname
IP	ip_address	-ip_address
Vuln.	vuln_count	-vuln_count

🚩 GET /api/assets//

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

🚩 GET /api/assets/?vulnerability=

List hosts by vulnerability

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

🚩 PATCH /api/vulnerability/<vuln_pk>/asset/<asset_pk>/update

API to mark that a vulnerability has been fixed for a given host

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

	active	inactive
status	1	0

Body

  {
    "status": 0
  }

🚩 GET /api/vulnerabilities/

list vulnerabilities

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

🚩 GET /api/vulnerabilities/?asset=

list vulnerabilities by host

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

🚩 GET /api/vulnerabilities/?severity=

list vulnerabilities by severity

	BAIXO	MÉDIO	ALTO	CRÍTICO

Request Headers

  {
    "Authorization": "Token ****************************************",
  }

🚩 GET /api/vulnerabilities/?ordering=-asset_count

list vulnerabilities ordering

Order by	Ascending	Descending
Título	title	-title
Severidade	severity	-severity
CVSS	cvss	-cvss
Hosts	hosts	-hosts

Request Headers

  {
    "Authorization": "Token ****************************************",
  }