Skip to content

Latest commit

 

History

History
242 lines (180 loc) · 5.97 KB

API-INTEGRATION.md

File metadata and controls

242 lines (180 loc) · 5.97 KB
Raw

VULNRΞPO API Reference

If you want to build your own backend system for VULNRΞPO you are in the right place! You choose the technology in which you will manage and store the reports. VULNRΞPO has a simple integration with the backend api, the requests described below.

Example API server

Please note that this is just example how to integrate with VULNRΞPO. The server is intended for personal use!

Visit: https://github.com/kac89/vulnrepo-server

API Reference

Init request: apiconnect

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: apiconnect

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

{"AUTH": "OK", "WELCOME": "John Doe", "CREATEDATE": "2021-05-14", "EXPIRYDATE": "2025-03-18", "CURRENT_STORAGE": "1000000", "MAX_STORAGE": "10000000"}
Parameter Type Description
API-ACCESS-KEY string Required. Your API key
WELCOME string User name
CREATEDATE string Create account date
EXPIRYDATE string Access validity period (is not mandatory)
CURRENT_STORAGE string Current storage used (in bytes) on API
MAX_STORAGE string Max storage available (in bytes) on API

getreportslist: Get all reports items

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: getreportslist
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

[{"report_id":"[report_id]","report_name":"Test Report","report_createdate":1606571788759,"report_lastupdate":1608657635687}]
Parameter Type Description
API-ACCESS-KEY string Required. Your API key

getreport

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: getreport
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

reportid=[report_id]

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

[{"report_id":"[report_id]","report_name":"Test report 21","report_createdate":1616859952914,"report_lastupdate":"","encrypted_data":"U2FsdGVkX1+t8fhgoP...[trunked]"}]
Parameter Type Description
API-ACCESS-KEY string Required. Your API key
report_id string Required. Report ID to remove

removereport

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: removereport
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

reportid=[report_id]

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

{"REMOVE_REPORT": "OK"}
Parameter Type Description
API-ACCESS-KEY string Required. Your API key
report_id string Required. Report ID to remove

savereport

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: savereport
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

reportdata=[base64_encode(report)]

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

{"REPORT_SAVED": "OK"}

ERROR response:

No space on API:

{"STORAGE": "NOSPACE"}
Parameter Type Description
API-ACCESS-KEY string Required. Your API key
reportdata string Required. Report data encrypted base64

updatereport

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: updatereport
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

reportdata=[base64_encode(report)]

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

{"REPORT_UPDATE": "OK"}

ERROR response:

No space on API:

{"STORAGE": "NOSPACE"}
Parameter Type Description
API-ACCESS-KEY string Required. Your API key
reportdata string Required. Report data encrypted base64

getreportprofiles: Get all reports profiles settings

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: getreportprofiles
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

[{"[trunked]"}]
Parameter Type Description
API-ACCESS-KEY string Required. Your API key

getreporttemplates: Get all issue templates

Request:

POST /api/ HTTP/2
Vulnrepo-Auth: [API-ACCESS-KEY]
Vulnrepo-Action: getreporttemplates
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Response:

HTTP/2 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: vulnrepo-auth, vulnrepo-action

[{"[trunked]"}]
Parameter Type Description
API-ACCESS-KEY string Required. Your API key