API Vulnerability Workflow¶
-
POST
/api/v1/
(api_key)/vulnerability/
(vulnerability_id)/update
¶ New in version 1.0.
Update a vulnerability.
Example request:
POST /api/v1/44df57d3f5a479e334e622f314787dcc/vulnerability/656c83c5a79197d3b5dae238016736aa335a13f9/update HTTP/1.1 Host: api.appcheck-ng.com Accept-Encoding: identity Content-Length: 63 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 notes=Internal+test+network&priority=low&status=acceptable_risk
Example response:
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 86 Date: Wed, 08 May 2019 11:27:48 GMT { "errors": null, "message": "Vulnerability has been updated", "success": true }
Parameters: - api_key (string) – Your API key
- vulnerability_id (string) – ID of the vulnerability
Form Parameters: - status – (optional) vulnerability status of the vulnerability
- notes – (optional) user provided notes of the vulnerability
- priority – (optional) priority of the vulnerability, can be changed by the user
Response Headers: - Content-Type – application/json
Response JSON Object: - success (boolean) – operation was successful
- message (string) – human readable response
- errors (strings) – detailed list of errors
Status Codes:
-
POST
/api/v1/
(api_key)/vulnerability/
(vuln_id)/delete
¶ New in version 1.0.
Delete a vulnerability
Example request:
POST /api/v1/44df57d3f5a479e334e622f314787dcc/vulnerability/656c83c5a79197d3b5dae238016736aa335a13f9/delete HTTP/1.1 Host: api.appcheck-ng.com Accept-Encoding: identity Content-Length: 0
Example response:
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 68 Date: Wed, 08 May 2019 11:27:59 GMT { "message": "Vulnerability has been deleted", "success": true }
Parameters: - api_key (string) – Your API key
- vuln_id (string) – ID of the vulnerability
Response Headers: - Content-Type – application/json
Response JSON Object: - success (boolean) – operation was successful
- message (string) – human readable response
Status Codes: