diff --git a/index.html b/index.html index 7a0bbe2..070239b 100644 --- a/index.html +++ b/index.html @@ -446,6 +446,9 @@
++Code samples
+
# You can also use wget
+curl -X GET /api/auth/assets/export/json \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+
+
GET /api/auth/assets/export/json HTTP/1.1
+
+Accept: application/json
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+};
+
+fetch('/api/auth/assets/export/json',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
require 'rest-client'
+require 'json'
+
+headers = {
+ 'Accept' => 'application/json',
+ 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+result = RestClient.get '/api/auth/assets/export/json',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+r = requests.get('/api/auth/assets/export/json', headers = headers)
+
+print(r.json())
+
+
<?php
+
+require 'vendor/autoload.php';
+
+$headers = array(
+ 'Accept' => 'application/json',
+ 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/auth/assets/export/json', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
URL obj = new URL("/api/auth/assets/export/json");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
package main
+
+import (
+ "bytes"
+ "net/http"
+)
+
+func main() {
+
+ headers := map[string][]string{
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"},
+ }
+
+ data := bytes.NewBuffer([]byte{jsonReq})
+ req, err := http.NewRequest("GET", "/api/auth/assets/export/json", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
GET /api/auth/assets/export/json
API endpoint that allows Assets to be viewed or edited.
+ +++Example responses
+ +200 Response
+
{
+ "id": 0,
+ "value": "string",
+ "criticality": 1,
+ "type": "ip",
+ "description": "string",
+ "exposure": "unknown",
+ "is_active": true,
+ "score": 0,
+ "is_monitored": true,
+ "created_by": "string",
+ "created_at": "2019-08-24T14:15:22Z",
+ "updated_at": "2019-08-24T14:15:22Z",
+ "score_level": "string",
+ "technologies": "string",
+ "asset_owners": "string",
+ "groups": "string",
+ "organization": 0,
+ "last_checked_at": "string",
+ "pentest_data": "string",
+ "asset_tags": "string",
+ "waf_provider": "string",
+ "cdn_provider": "string",
+ "saas_provider": "string",
+ "cloud_provider": "string",
+ "suborganizations": [
+ 0
+ ],
+ "security_checks": "string",
+ "monitored_slot_lock_until": "2019-08-24T14:15:22Z",
+ "is_up": true
+}
+
Status | +Meaning | +Description | +Schema | +
---|---|---|---|
200 | +OK | +none | +Asset | +
title: string
description: string
@@ -10241,6 +10483,7 @@ assets_group_create
suborganizations:
- 0
is_dynamic: true
+criticality: 1
title: string
description: string
@@ -10838,6 +11085,7 @@ assets_group_partial_update
suborganizations:
- 0
is_dynamic: true
+criticality: 1
title: string
description: string
@@ -11955,6 +12206,7 @@ assets_group_filters_create
suborganizations:
- 0
is_dynamic: true
+criticality: 1
title: string
description: string
@@ -12365,6 +12620,7 @@ assets_group_owners_create
suborganizations:
- 0
is_dynamic: true
+criticality: 1
title: string
description: string
@@ -13423,6 +13683,7 @@ assets_group_export_csv_create
suborganizations:
- 0
is_dynamic: true
+criticality: 1
Code samples
# You can also use wget
-curl -X GET /api/auth/report/{org_id} \
+curl -X POST /api/auth/report/{org_id} \
+ -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/report/{org_id} HTTP/1.1
+
POST /api/auth/report/{org_id} HTTP/1.1
+Content-Type: application/json
Accept: application/json
-
+
const inputBody = '{
+ "emails": [
+ "user@example.com"
+ ],
+ "assets": [
+ 0
+ ],
+ "vulnerabilities": [
+ 0
+ ],
+ "assetgroups": [
+ 0
+ ],
+ "assets_from_assetgroups": [
+ 0
+ ],
+ "vulnerabilities_from_assetgroups": [
+ 0
+ ],
+ "pentests": [
+ 0
+ ],
+ "assets_from_pentests": [
+ 0
+ ],
+ "vulnerabilities_from_pentests": [
+ 0
+ ],
+ "suborganizations": [
+ 0
+ ]
+}';
const headers = {
+ 'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
fetch('/api/auth/report/{org_id}',
{
- method: 'GET',
-
+ method: 'POST',
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -27269,11 +27573,12 @@ report_retrieve
require 'json'
headers = {
+ 'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/report/{org_id}',
+result = RestClient.post '/api/auth/report/{org_id}',
params: {
}, headers: headers
@@ -27281,11 +27586,12 @@ report_retrieve
import requests
headers = {
+ 'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/report/{org_id}', headers = headers)
+r = requests.post('/api/auth/report/{org_id}', headers = headers)
print(r.json())
@@ -27294,6 +27600,7 @@ report_retrieve
require 'vendor/autoload.php';
$headers = array(
+ 'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345',
);
@@ -27304,7 +27611,7 @@ report_retrieve
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/report/{org_id}', array(
+ $response = $client->request('POST','/api/auth/report/{org_id}', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -27320,7 +27627,7 @@ report_retrieve
URL obj = new URL("/api/auth/report/{org_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -27342,12 +27649,13 @@ report_retrieve
func main() {
headers := map[string][]string{
+ "Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/report/{org_id}", data)
+ req, err := http.NewRequest("POST", "/api/auth/report/{org_id}", data)
req.Header = headers
client := &http.Client{}
@@ -27356,12 +27664,69 @@ report_retrieve
}
GET /api/auth/report/{org_id}
POST /api/auth/report/{org_id}
Generate a PDF report and receive it by email. Without parameter, it will generate a global report with all vulnerabilities raised by Patrowl. Otherwise, you can specify which data to export.
-++Body parameter
+
{
+ "emails": [
+ "user@example.com"
+ ],
+ "assets": [
+ 0
+ ],
+ "vulnerabilities": [
+ 0
+ ],
+ "assetgroups": [
+ 0
+ ],
+ "assets_from_assetgroups": [
+ 0
+ ],
+ "vulnerabilities_from_assetgroups": [
+ 0
+ ],
+ "pentests": [
+ 0
+ ],
+ "assets_from_pentests": [
+ 0
+ ],
+ "vulnerabilities_from_pentests": [
+ 0
+ ],
+ "suborganizations": [
+ 0
+ ]
+}
+
emails:
+ - user@example.com
+assets:
+ - 0
+vulnerabilities:
+ - 0
+assetgroups:
+ - 0
+assets_from_assetgroups:
+ - 0
+vulnerabilities_from_assetgroups:
+ - 0
+pentests:
+ - 0
+assets_from_pentests:
+ - 0
+vulnerabilities_from_pentests:
+ - 0
+suborganizations:
+ - 0
+
+
assetgroups | -query | -array[number] | -false | -Export specified asset groups (it will generate report from these asset groups' assets). | -||||
assets | -query | -array[number] | -false | -Export specified assets. | -||||
assets_from_assetgroups | -query | -array[number] | -false | -Export assets from specified asset groups. | -||||
assets_from_pentests | -query | -array[number] | -false | -Export assets from specified external imported pentests. | -||||
org_id | path | string | @@ -27408,32 +27745,11 @@Your organization ID. | |||||
pentests | -query | -array[number] | -false | -Export specified external imported pentests (it will generate report from these pentests' vulnerabilities). | -||||
vulnerabilities | -query | -array[number] | -false | -Export specified vulnerabilities. | -||||
vulnerabilities_from_assetgroups | -query | -array[number] | -false | -Export vulnerabilities from specified asset groups. | -||||
vulnerabilities_from_pentests | -query | -array[number] | +body | +body | +DownloadReporting | false | -Export vulnerabilities from specified external imported pentests. | +none |
Number of results to return per page. | ||||
not_remediation_id | +query | +string | +false | +none | +
not_vuln_owner | query | string | @@ -30106,6 +30429,8 @@
++Code samples
+
# You can also use wget
+curl -X PATCH /api/auth/vulns/{id}/comments/{comment_id} \
+ -H 'Content-Type: application/json' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+
+
PATCH /api/auth/vulns/{id}/comments/{comment_id} HTTP/1.1
+
+Content-Type: application/json
+Accept: application/json
+
+
const inputBody = '{
+ "patrowl_id": -2147483648,
+ "asset": 0,
+ "organization": 0,
+ "severity": 0,
+ "cvss_vector": "string",
+ "status": "new",
+ "title": "string",
+ "description": "string",
+ "description_html": "string",
+ "source": "string",
+ "external_id": {
+ "property1": null,
+ "property2": null
+ },
+ "category": "string",
+ "business_impacts": [
+ "string"
+ ],
+ "has_exploit": true,
+ "solution_headline": "string",
+ "solution": "string",
+ "solution_html": "string",
+ "solution_priority": "urgent",
+ "solution_effort": "low",
+ "solution_gain": -2147483648,
+ "owners": [
+ 0
+ ],
+ "solution_duedate": "2019-08-24T14:15:22Z",
+ "is_quickwin": true,
+ "is_auto": true,
+ "is_greybox": true,
+ "remediation_date": "2019-08-24T14:15:22Z",
+ "last_status_update": "2019-08-24T14:15:22Z",
+ "found_at": "2019-08-24T14:15:22Z",
+ "last_checked_at": "2019-08-24T14:15:22Z",
+ "created_at": "2019-08-24T14:15:22Z",
+ "updated_at": "2019-08-24T14:15:22Z",
+ "ticketstatus": -2147483648,
+ "solution_owners": [
+ 0
+ ],
+ "updated_by_user_at": "2019-08-24T14:15:22Z"
+}';
+const headers = {
+ 'Content-Type':'application/json',
+ 'Accept':'application/json',
+ 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+};
+
+fetch('/api/auth/vulns/{id}/comments/{comment_id}',
+{
+ method: 'PATCH',
+ body: inputBody,
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
require 'rest-client'
+require 'json'
+
+headers = {
+ 'Content-Type' => 'application/json',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+result = RestClient.patch '/api/auth/vulns/{id}/comments/{comment_id}',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
import requests
+headers = {
+ 'Content-Type': 'application/json',
+ 'Accept': 'application/json',
+ 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+r = requests.patch('/api/auth/vulns/{id}/comments/{comment_id}', headers = headers)
+
+print(r.json())
+
+
<?php
+
+require 'vendor/autoload.php';
+
+$headers = array(
+ 'Content-Type' => 'application/json',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PATCH','/api/auth/vulns/{id}/comments/{comment_id}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
URL obj = new URL("/api/auth/vulns/{id}/comments/{comment_id}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("PATCH");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
package main
+
+import (
+ "bytes"
+ "net/http"
+)
+
+func main() {
+
+ headers := map[string][]string{
+ "Content-Type": []string{"application/json"},
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"},
+ }
+
+ data := bytes.NewBuffer([]byte{jsonReq})
+ req, err := http.NewRequest("PATCH", "/api/auth/vulns/{id}/comments/{comment_id}", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
PATCH /api/auth/vulns/{id}/comments/{comment_id}
Edit an existing comments.
+ +:return 404: Vuln or comment not found
+ +:return 201: Success
+ +++Body parameter
+
{
+ "patrowl_id": -2147483648,
+ "asset": 0,
+ "organization": 0,
+ "severity": 0,
+ "cvss_vector": "string",
+ "status": "new",
+ "title": "string",
+ "description": "string",
+ "description_html": "string",
+ "source": "string",
+ "external_id": {
+ "property1": null,
+ "property2": null
+ },
+ "category": "string",
+ "business_impacts": [
+ "string"
+ ],
+ "has_exploit": true,
+ "solution_headline": "string",
+ "solution": "string",
+ "solution_html": "string",
+ "solution_priority": "urgent",
+ "solution_effort": "low",
+ "solution_gain": -2147483648,
+ "owners": [
+ 0
+ ],
+ "solution_duedate": "2019-08-24T14:15:22Z",
+ "is_quickwin": true,
+ "is_auto": true,
+ "is_greybox": true,
+ "remediation_date": "2019-08-24T14:15:22Z",
+ "last_status_update": "2019-08-24T14:15:22Z",
+ "found_at": "2019-08-24T14:15:22Z",
+ "last_checked_at": "2019-08-24T14:15:22Z",
+ "created_at": "2019-08-24T14:15:22Z",
+ "updated_at": "2019-08-24T14:15:22Z",
+ "ticketstatus": -2147483648,
+ "solution_owners": [
+ 0
+ ],
+ "updated_by_user_at": "2019-08-24T14:15:22Z"
+}
+
patrowl_id: -2147483648
+asset: 0
+organization: 0
+severity: 0
+cvss_vector: string
+status: new
+title: string
+description: string
+description_html: string
+source: string
+external_id:
+ ? property1
+ ? property2
+category: string
+business_impacts:
+ - string
+has_exploit: true
+solution_headline: string
+solution: string
+solution_html: string
+solution_priority: urgent
+solution_effort: low
+solution_gain: -2147483648
+owners:
+ - 0
+solution_duedate: 2019-08-24T14:15:22Z
+is_quickwin: true
+is_auto: true
+is_greybox: true
+remediation_date: 2019-08-24T14:15:22Z
+last_status_update: 2019-08-24T14:15:22Z
+found_at: 2019-08-24T14:15:22Z
+last_checked_at: 2019-08-24T14:15:22Z
+created_at: 2019-08-24T14:15:22Z
+updated_at: 2019-08-24T14:15:22Z
+ticketstatus: -2147483648
+solution_owners:
+ - 0
+updated_by_user_at: 2019-08-24T14:15:22Z
+
+
Name | +In | +Type | +Required | +Description | +
---|---|---|---|---|
comment_id | +path | +integer | +true | +none | +
id | +path | +integer | +true | +none | +
body | +body | +PatchedVulnerability | +false | +none | +
++Example responses
+ +200 Response
+
{
+ "property1": null,
+ "property2": null
+}
+
Status | +Meaning | +Description | +Schema | +
---|---|---|---|
200 | +OK | +none | +Inline | +
404 | +Not Found | +none | +Inline | +
Status Code 200
+ +Unspecified response body
+ +Name | +Type | +Required | +Restrictions | +Description | +
---|---|---|---|---|
» additionalProperties | +any | +false | +none | +none | +
Status Code 404
+ +Unspecified response body
+ +Name | +Type | +Required | +Restrictions | +Description | +
---|---|---|---|---|
» additionalProperties | +any | +false | +none | +none | +
const inputBody = '{
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"organization": 0,
"severity": 0,
@@ -33343,7 +34068,7 @@ vulns_owners_create
Body parameter
{
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"organization": 0,
"severity": 0,
@@ -33387,7 +34112,7 @@ vulns_owners_create
],
"updated_by_user_at": "2019-08-24T14:15:22Z"
}
-
arsenal_id: -2147483648
+
patrowl_id: -2147483648
asset: 0
organization: 0
severity: 0
@@ -33463,7 +34188,7 @@ Parameters
{
"id": 0,
"user_friendly_id": "string",
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"asset_id": "string",
"organization": 0,
@@ -33510,7 +34235,7 @@ Parameters
"vuln_owners": "string",
"vuln_solution_owners": "string",
"suborganizations": "string",
- "arsenal_vulnerability": {
+ "external_vulnerability": {
"id": 0,
"title": "string",
"description": "string",
@@ -34224,6 +34949,13 @@ Parameters
Number of results to return per page.
const inputBody = '{
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"organization": 0,
"severity": 0,
@@ -35203,7 +35935,7 @@ vulns_solution_owners_create
Body parameter
{
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"organization": 0,
"severity": 0,
@@ -35247,7 +35979,7 @@ vulns_solution_owners_create
],
"updated_by_user_at": "2019-08-24T14:15:22Z"
}
-
arsenal_id: -2147483648
+
patrowl_id: -2147483648
asset: 0
organization: 0
severity: 0
@@ -35323,7 +36055,7 @@ Parameters
{
"id": 0,
"user_friendly_id": "string",
- "arsenal_id": -2147483648,
+ "patrowl_id": -2147483648,
"asset": 0,
"asset_id": "string",
"organization": 0,
@@ -35370,7 +36102,7 @@ Parameters
"vuln_owners": "string",
"vuln_solution_owners": "string",
"suborganizations": "string",
- "arsenal_vulnerability": {
+ "external_vulnerability": {
"id": 0,
"title": "string",
"description": "string",
@@ -35847,6 +36579,13 @@ Parameters
Number of results to return per page.
Code samples
# You can also use wget
-curl -X DELETE /api/auth/vulns/attachements/{id}/ \
+curl -X GET /api/auth/vulns/{user_friendly_id}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
DELETE /api/auth/vulns/attachements/{id}/ HTTP/1.1
+
GET /api/auth/vulns/{user_friendly_id}/ HTTP/1.1
Accept: application/json
@@ -36434,9 +37173,9 @@ vulnerabilities_delete_file_att
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/attachements/{id}/',
+fetch('/api/auth/vulns/{user_friendly_id}/',
{
- method: 'DELETE',
+ method: 'GET',
headers: headers
})
@@ -36454,7 +37193,7 @@ vulnerabilities_delete_file_att
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.delete '/api/auth/vulns/attachements/{id}/',
+result = RestClient.get '/api/auth/vulns/{user_friendly_id}/',
params: {
}, headers: headers
@@ -36466,7 +37205,7 @@ vulnerabilities_delete_file_att
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.delete('/api/auth/vulns/attachements/{id}/', headers = headers)
+r = requests.get('/api/auth/vulns/{user_friendly_id}/', headers = headers)
print(r.json())
@@ -36485,7 +37224,7 @@ vulnerabilities_delete_file_att
$request_body = array();
try {
- $response = $client->request('DELETE','/api/auth/vulns/attachements/{id}/', array(
+ $response = $client->request('GET','/api/auth/vulns/{user_friendly_id}/', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -36499,9 +37238,9 @@ vulnerabilities_delete_file_att
// ...
-
URL obj = new URL("/api/auth/vulns/attachements/{id}/");
+
URL obj = new URL("/api/auth/vulns/{user_friendly_id}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -36528,7 +37267,7 @@ vulnerabilities_delete_file_att
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/auth/vulns/attachements/{id}/", data)
+ req, err := http.NewRequest("GET", "/api/auth/vulns/{user_friendly_id}/", data)
req.Header = headers
client := &http.Client{}
@@ -36537,19 +37276,11 @@ vulnerabilities_delete_file_att
}
DELETE /api/auth/vulns/attachements/{id}/
Delete file link to a vulnerability
- -:return 404: File not found
- -:return 403: Unauthorized to delete file upload by Patrowl
- -:return 400: Unable to delete this file
+GET /api/auth/vulns/{user_friendly_id}/
:return 204: Success
+API endpoint that allows Vulnerabilities to be viewed or edited.
-id | +user_friendly_id | path | -integer | +string | true | none |
204 | -No Content | -none | -Inline | -
400 | -Bad Request | -none | -BasicResponseWithMessage | -
403 | -Forbidden | -none | -BasicResponseWithMessage | -
404 | -Not Found | -none | -Inline | -
Status Code 204
- -Unspecified response body
- -Name | -Type | -Required | -Restrictions | -Description | -
---|---|---|---|---|
» additionalProperties | -any | -false | -none | -none | -
Status Code 404
- -Unspecified response body
- -Name | -Type | -Required | -Restrictions | -Description | -|||
---|---|---|---|---|---|---|---|
» additionalProperties | -any | -false | -none | +200 | +OK | none | +Vulnerability |
Code samples
# You can also use wget
-curl -X GET /api/auth/vulns/by-efforts \
+curl -X DELETE /api/auth/vulns/attachements/{id}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/vulns/by-efforts HTTP/1.1
+
DELETE /api/auth/vulns/attachements/{id}/ HTTP/1.1
Accept: application/json
@@ -36685,9 +37415,9 @@ vulnerabilities_efforts
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/by-efforts',
+fetch('/api/auth/vulns/attachements/{id}/',
{
- method: 'GET',
+ method: 'DELETE',
headers: headers
})
@@ -36705,7 +37435,7 @@ vulnerabilities_efforts
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/vulns/by-efforts',
+result = RestClient.delete '/api/auth/vulns/attachements/{id}/',
params: {
}, headers: headers
@@ -36717,7 +37447,7 @@ vulnerabilities_efforts
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/vulns/by-efforts', headers = headers)
+r = requests.delete('/api/auth/vulns/attachements/{id}/', headers = headers)
print(r.json())
@@ -36736,7 +37466,7 @@ vulnerabilities_efforts
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/vulns/by-efforts', array(
+ $response = $client->request('DELETE','/api/auth/vulns/attachements/{id}/', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -36750,9 +37480,9 @@ vulnerabilities_efforts
// ...
-
URL obj = new URL("/api/auth/vulns/by-efforts");
+
URL obj = new URL("/api/auth/vulns/attachements/{id}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -36779,7 +37509,7 @@ vulnerabilities_efforts
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/vulns/by-efforts", data)
+ req, err := http.NewRequest("DELETE", "/api/auth/vulns/attachements/{id}/", data)
req.Header = headers
client := &http.Client{}
@@ -36788,23 +37518,49 @@ vulnerabilities_efforts
}
GET /api/auth/vulns/by-efforts
DELETE /api/auth/vulns/attachements/{id}/
Recommendations by effort Data corresponding to the recommendations total on each effort types
+Delete file link to a vulnerability
-:return 200: Success
+:return 404: File not found
+ +:return 403: Unauthorized to delete file upload by Patrowl
+ +:return 400: Unable to delete this file
+ +:return 204: Success
+ +Name | +In | +Type | +Required | +Description | +
---|---|---|---|---|
id | +path | +integer | +true | +none | +
Example responses
-200 Response
+204 Response
{
"property1": null,
"property2": null
}
200 | -OK | +204 | +No Content | +none | +Inline | +
400 | +Bad Request | +none | +BasicResponseWithMessage | +||
403 | +Forbidden | +none | +BasicResponseWithMessage | +||
404 | +Not Found | none | Inline |
Status Code 200
+Status Code 204
+ +Unspecified response body
+ +Name | +Type | +Required | +Restrictions | +Description | +
---|---|---|---|---|
» additionalProperties | +any | +false | +none | +none | +
Status Code 404
Unspecified response body
@@ -36849,18 +37645,18 @@Code samples
# You can also use wget
-curl -X GET /api/auth/vulns/by-priorities \
+curl -X GET /api/auth/vulns/by-efforts \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/vulns/by-priorities HTTP/1.1
+
GET /api/auth/vulns/by-efforts HTTP/1.1
Accept: application/json
@@ -36870,7 +37666,7 @@ vulnerabilities_priorities
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/by-priorities',
+fetch('/api/auth/vulns/by-efforts',
{
method: 'GET',
@@ -36890,7 +37686,7 @@ vulnerabilities_priorities
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/vulns/by-priorities',
+result = RestClient.get '/api/auth/vulns/by-efforts',
params: {
}, headers: headers
@@ -36902,7 +37698,7 @@ vulnerabilities_priorities
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/vulns/by-priorities', headers = headers)
+r = requests.get('/api/auth/vulns/by-efforts', headers = headers)
print(r.json())
@@ -36921,7 +37717,7 @@ vulnerabilities_priorities
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/vulns/by-priorities', array(
+ $response = $client->request('GET','/api/auth/vulns/by-efforts', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -36935,7 +37731,7 @@ vulnerabilities_priorities
// ...
-
URL obj = new URL("/api/auth/vulns/by-priorities");
+
URL obj = new URL("/api/auth/vulns/by-efforts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36964,7 +37760,7 @@ vulnerabilities_priorities
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/vulns/by-priorities", data)
+ req, err := http.NewRequest("GET", "/api/auth/vulns/by-efforts", data)
req.Header = headers
client := &http.Client{}
@@ -36973,9 +37769,9 @@ vulnerabilities_priorities
}
GET /api/auth/vulns/by-priorities
GET /api/auth/vulns/by-efforts
Recommendations by priority data corresponding to the recommendations total on each priority types
+Recommendations by effort Data corresponding to the recommendations total on each effort types
:return 200: Success
@@ -36989,7 +37785,7 @@Status Code 200
@@ -37034,18 +37830,18 @@Code samples
# You can also use wget
-curl -X GET /api/auth/vulns/by-severity-and-time \
+curl -X GET /api/auth/vulns/by-priorities \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/vulns/by-severity-and-time HTTP/1.1
+
GET /api/auth/vulns/by-priorities HTTP/1.1
Accept: application/json
@@ -37055,7 +37851,7 @@ vulnerabilities_severity_and_time
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/by-severity-and-time',
+fetch('/api/auth/vulns/by-priorities',
{
method: 'GET',
@@ -37075,7 +37871,7 @@ vulnerabilities_severity_and_time
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/vulns/by-severity-and-time',
+result = RestClient.get '/api/auth/vulns/by-priorities',
params: {
}, headers: headers
@@ -37087,7 +37883,7 @@ vulnerabilities_severity_and_time
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/vulns/by-severity-and-time', headers = headers)
+r = requests.get('/api/auth/vulns/by-priorities', headers = headers)
print(r.json())
@@ -37106,7 +37902,7 @@ vulnerabilities_severity_and_time
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/vulns/by-severity-and-time', array(
+ $response = $client->request('GET','/api/auth/vulns/by-priorities', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -37120,7 +37916,7 @@ vulnerabilities_severity_and_time
// ...
-
URL obj = new URL("/api/auth/vulns/by-severity-and-time");
+
URL obj = new URL("/api/auth/vulns/by-priorities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37149,7 +37945,7 @@ vulnerabilities_severity_and_time
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/vulns/by-severity-and-time", data)
+ req, err := http.NewRequest("GET", "/api/auth/vulns/by-priorities", data)
req.Header = headers
client := &http.Client{}
@@ -37158,9 +37954,9 @@ vulnerabilities_severity_and_time
}
GET /api/auth/vulns/by-severity-and-time
GET /api/auth/vulns/by-priorities
Overdues recommendations by severity and time data corresponding to the recommendations total on each severity types & time
+Recommendations by priority data corresponding to the recommendations total on each priority types
:return 200: Success
@@ -37174,7 +37970,7 @@Status Code 200
@@ -37219,18 +38015,18 @@Code samples
# You can also use wget
-curl -X GET /api/auth/vulns/by-vulns-status \
+curl -X GET /api/auth/vulns/by-severity-and-time \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/vulns/by-vulns-status HTTP/1.1
+
GET /api/auth/vulns/by-severity-and-time HTTP/1.1
Accept: application/json
@@ -37240,7 +38036,7 @@ vulnerabilities_status_vuln
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/by-vulns-status',
+fetch('/api/auth/vulns/by-severity-and-time',
{
method: 'GET',
@@ -37260,7 +38056,7 @@ vulnerabilities_status_vuln
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/vulns/by-vulns-status',
+result = RestClient.get '/api/auth/vulns/by-severity-and-time',
params: {
}, headers: headers
@@ -37272,7 +38068,7 @@ vulnerabilities_status_vuln
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/vulns/by-vulns-status', headers = headers)
+r = requests.get('/api/auth/vulns/by-severity-and-time', headers = headers)
print(r.json())
@@ -37291,7 +38087,7 @@ vulnerabilities_status_vuln
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/vulns/by-vulns-status', array(
+ $response = $client->request('GET','/api/auth/vulns/by-severity-and-time', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -37305,7 +38101,7 @@ vulnerabilities_status_vuln
// ...
-
URL obj = new URL("/api/auth/vulns/by-vulns-status");
+
URL obj = new URL("/api/auth/vulns/by-severity-and-time");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37334,7 +38130,7 @@ vulnerabilities_status_vuln
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/vulns/by-vulns-status", data)
+ req, err := http.NewRequest("GET", "/api/auth/vulns/by-severity-and-time", data)
req.Header = headers
client := &http.Client{}
@@ -37343,9 +38139,9 @@ vulnerabilities_status_vuln
}
GET /api/auth/vulns/by-vulns-status
GET /api/auth/vulns/by-severity-and-time
Data corresponding to the total recomm on each effort types.
+Overdues recommendations by severity and time data corresponding to the recommendations total on each severity types & time
:return 200: Success
@@ -37359,7 +38155,7 @@Status Code 200
@@ -37404,18 +38200,18 @@Code samples
# You can also use wget
-curl -X GET /api/auth/vulns/export/csv \
+curl -X GET /api/auth/vulns/by-vulns-status \
-H 'Accept: application/json' \
-H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
-
GET /api/auth/vulns/export/csv HTTP/1.1
+
GET /api/auth/vulns/by-vulns-status HTTP/1.1
Accept: application/json
@@ -37425,7 +38221,7 @@ vulnerabilities_export_csv
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
};
-fetch('/api/auth/vulns/export/csv',
+fetch('/api/auth/vulns/by-vulns-status',
{
method: 'GET',
@@ -37445,7 +38241,7 @@ vulnerabilities_export_csv
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-result = RestClient.get '/api/auth/vulns/export/csv',
+result = RestClient.get '/api/auth/vulns/by-vulns-status',
params: {
}, headers: headers
@@ -37457,7 +38253,7 @@ vulnerabilities_export_csv
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
}
-r = requests.get('/api/auth/vulns/export/csv', headers = headers)
+r = requests.get('/api/auth/vulns/by-vulns-status', headers = headers)
print(r.json())
@@ -37476,7 +38272,7 @@ vulnerabilities_export_csv
$request_body = array();
try {
- $response = $client->request('GET','/api/auth/vulns/export/csv', array(
+ $response = $client->request('GET','/api/auth/vulns/by-vulns-status', array(
'headers' => $headers,
'json' => $request_body,
)
@@ -37490,7 +38286,7 @@ vulnerabilities_export_csv
// ...
-
URL obj = new URL("/api/auth/vulns/export/csv");
+
URL obj = new URL("/api/auth/vulns/by-vulns-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37519,7 +38315,7 @@ vulnerabilities_export_csv
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/auth/vulns/export/csv", data)
+ req, err := http.NewRequest("GET", "/api/auth/vulns/by-vulns-status", data)
req.Header = headers
client := &http.Client{}
@@ -37528,9 +38324,11 @@ vulnerabilities_export_csv
}
GET /api/auth/vulns/export/csv
GET /api/auth/vulns/by-vulns-status
Export vulnerabilities as CSV.
+Data corresponding to the total recomm on each effort types.
+ +:return 200: Success
Example responses
@@ -37542,7 +38340,7 @@vulnerabilities_export_csv
"property2": null } -Responses
+Responses
-
@@ -37558,21 +38356,9 @@ -Responses
none Inline - -400 -Bad Request -none -BasicResponseWithMessage -- 403 -Forbidden -none -BasicResponseWithMessage -Response Schema
+Response Schema
Status Code 200
@@ -37599,78 +38385,31 @@Response Schema
-vulnerabilities_export_csv_2
- +vulnerabilities_export_csv
+Code samples
# You can also use wget -curl -X POST /api/auth/vulns/export/csv \ - -H 'Content-Type: application/json' \ +curl -X GET /api/auth/vulns/export/csv \ -H 'Accept: application/json' \ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' -
POST /api/auth/vulns/export/csv HTTP/1.1 +
GET /api/auth/vulns/export/csv HTTP/1.1 -Content-Type: application/json Accept: application/json -
const inputBody = '{ - "arsenal_id": -2147483648, - "asset": 0, - "organization": 0, - "severity": 0, - "cvss_vector": "string", - "status": "new", - "title": "string", - "description": "string", - "description_html": "string", - "source": "string", - "external_id": { - "property1": null, - "property2": null - }, - "category": "string", - "business_impacts": [ - "string" - ], - "has_exploit": true, - "solution_headline": "string", - "solution": "string", - "solution_html": "string", - "solution_priority": "urgent", - "solution_effort": "low", - "solution_gain": -2147483648, - "owners": [ - 0 - ], - "solution_duedate": "2019-08-24T14:15:22Z", - "is_quickwin": true, - "is_auto": true, - "is_greybox": true, - "remediation_date": "2019-08-24T14:15:22Z", - "last_status_update": "2019-08-24T14:15:22Z", - "found_at": "2019-08-24T14:15:22Z", - "last_checked_at": "2019-08-24T14:15:22Z", - "created_at": "2019-08-24T14:15:22Z", - "updated_at": "2019-08-24T14:15:22Z", - "ticketstatus": -2147483648, - "solution_owners": [ - 0 - ], - "updated_by_user_at": "2019-08-24T14:15:22Z" -}'; +
const headers = { - 'Content-Type':'application/json', 'Accept':'application/json', 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' }; fetch('/api/auth/vulns/export/csv', { - method: 'POST', - body: inputBody, + method: 'GET', + headers: headers }) .then(function(res) { @@ -37683,12 +38422,11 @@
vulnerabilities_export_csv_2
require 'json' headers = { - 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -result = RestClient.post '/api/auth/vulns/export/csv', +result = RestClient.get '/api/auth/vulns/export/csv', params: { }, headers: headers @@ -37696,12 +38434,11 @@vulnerabilities_export_csv_2
import requests headers = { - 'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -r = requests.post('/api/auth/vulns/export/csv', headers = headers) +r = requests.get('/api/auth/vulns/export/csv', headers = headers) print(r.json()) @@ -37710,7 +38447,6 @@
vulnerabilities_export_csv_2
require 'vendor/autoload.php'; $headers = array( - 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345', ); @@ -37721,7 +38457,7 @@vulnerabilities_export_csv_2
$request_body = array(); try { - $response = $client->request('POST','/api/auth/vulns/export/csv', array( + $response = $client->request('GET','/api/auth/vulns/export/csv', array( 'headers' => $headers, 'json' => $request_body, ) @@ -37737,7 +38473,7 @@vulnerabilities_export_csv_2
-URL obj = new URL("/api/auth/vulns/export/csv"); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); +con.setRequestMethod("GET"); int responseCode = con.getResponseCode(); BufferedReader in = new BufferedReader( new InputStreamReader(con.getInputStream())); @@ -37759,13 +38495,12 @@
vulnerabilities_export_csv_2
func main() { headers := map[string][]string{ - "Content-Type": []string{"application/json"}, "Accept": []string{"application/json"}, "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"}, } data := bytes.NewBuffer([]byte{jsonReq}) - req, err := http.NewRequest("POST", "/api/auth/vulns/export/csv", data) + req, err := http.NewRequest("GET", "/api/auth/vulns/export/csv", data) req.Header = headers client := &http.Client{} @@ -37774,119 +38509,10 @@vulnerabilities_export_csv_2
}+
POST /api/auth/vulns/export/csv
GET /api/auth/vulns/export/csv
Export vulnerabilities as CSV.
---Body parameter
-{ - "arsenal_id": -2147483648, - "asset": 0, - "organization": 0, - "severity": 0, - "cvss_vector": "string", - "status": "new", - "title": "string", - "description": "string", - "description_html": "string", - "source": "string", - "external_id": { - "property1": null, - "property2": null - }, - "category": "string", - "business_impacts": [ - "string" - ], - "has_exploit": true, - "solution_headline": "string", - "solution": "string", - "solution_html": "string", - "solution_priority": "urgent", - "solution_effort": "low", - "solution_gain": -2147483648, - "owners": [ - 0 - ], - "solution_duedate": "2019-08-24T14:15:22Z", - "is_quickwin": true, - "is_auto": true, - "is_greybox": true, - "remediation_date": "2019-08-24T14:15:22Z", - "last_status_update": "2019-08-24T14:15:22Z", - "found_at": "2019-08-24T14:15:22Z", - "last_checked_at": "2019-08-24T14:15:22Z", - "created_at": "2019-08-24T14:15:22Z", - "updated_at": "2019-08-24T14:15:22Z", - "ticketstatus": -2147483648, - "solution_owners": [ - 0 - ], - "updated_by_user_at": "2019-08-24T14:15:22Z" -} -
-arsenal_id: -2147483648 -asset: 0 -organization: 0 -severity: 0 -cvss_vector: string -status: new -title: string -description: string -description_html: string -source: string -external_id: - ? property1 - ? property2 -category: string -business_impacts: - - string -has_exploit: true -solution_headline: string -solution: string -solution_html: string -solution_priority: urgent -solution_effort: low -solution_gain: -2147483648 -owners: - - 0 -solution_duedate: 2019-08-24T14:15:22Z -is_quickwin: true -is_auto: true -is_greybox: true -remediation_date: 2019-08-24T14:15:22Z -last_status_update: 2019-08-24T14:15:22Z -found_at: 2019-08-24T14:15:22Z -last_checked_at: 2019-08-24T14:15:22Z -created_at: 2019-08-24T14:15:22Z -updated_at: 2019-08-24T14:15:22Z -ticketstatus: -2147483648 -solution_owners: - - 0 -updated_by_user_at: 2019-08-24T14:15:22Z - -
Parameters
- --
-- - -Name -In -Type -Required -Description -- -body -body -Vulnerability -true -none -Example responses
@@ -37897,7 +38523,7 @@Parameters
"property2": null } -Responses
+Responses
-
@@ -37927,7 +38553,7 @@ Responses
Response Schema
+Response Schema
Status Code 200
@@ -37954,31 +38580,78 @@Response Schema
-vulnerabilities_by_severity
- +vulnerabilities_export_csv_2
+Code samples
# You can also use wget -curl -X GET /api/auth/vulns/severities \ +curl -X POST /api/auth/vulns/export/csv \ + -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' -
GET /api/auth/vulns/severities HTTP/1.1 +
POST /api/auth/vulns/export/csv HTTP/1.1 +Content-Type: application/json Accept: application/json -
+
const inputBody = '{ + "patrowl_id": -2147483648, + "asset": 0, + "organization": 0, + "severity": 0, + "cvss_vector": "string", + "status": "new", + "title": "string", + "description": "string", + "description_html": "string", + "source": "string", + "external_id": { + "property1": null, + "property2": null + }, + "category": "string", + "business_impacts": [ + "string" + ], + "has_exploit": true, + "solution_headline": "string", + "solution": "string", + "solution_html": "string", + "solution_priority": "urgent", + "solution_effort": "low", + "solution_gain": -2147483648, + "owners": [ + 0 + ], + "solution_duedate": "2019-08-24T14:15:22Z", + "is_quickwin": true, + "is_auto": true, + "is_greybox": true, + "remediation_date": "2019-08-24T14:15:22Z", + "last_status_update": "2019-08-24T14:15:22Z", + "found_at": "2019-08-24T14:15:22Z", + "last_checked_at": "2019-08-24T14:15:22Z", + "created_at": "2019-08-24T14:15:22Z", + "updated_at": "2019-08-24T14:15:22Z", + "ticketstatus": -2147483648, + "solution_owners": [ + 0 + ], + "updated_by_user_at": "2019-08-24T14:15:22Z" +}'; const headers = { + 'Content-Type':'application/json', 'Accept':'application/json', 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' }; -fetch('/api/auth/vulns/severities', +fetch('/api/auth/vulns/export/csv', { - method: 'GET', - + method: 'POST', + body: inputBody, headers: headers }) .then(function(res) { @@ -37991,11 +38664,12 @@
vulnerabilities_by_severity
require 'json' headers = { + 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -result = RestClient.get '/api/auth/vulns/severities', +result = RestClient.post '/api/auth/vulns/export/csv', params: { }, headers: headers @@ -38003,11 +38677,12 @@vulnerabilities_by_severity
import requests headers = { + 'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -r = requests.get('/api/auth/vulns/severities', headers = headers) +r = requests.post('/api/auth/vulns/export/csv', headers = headers) print(r.json()) @@ -38016,6 +38691,7 @@
vulnerabilities_by_severity
require 'vendor/autoload.php'; $headers = array( + 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345', ); @@ -38026,7 +38702,7 @@vulnerabilities_by_severity
$request_body = array(); try { - $response = $client->request('GET','/api/auth/vulns/severities', array( + $response = $client->request('POST','/api/auth/vulns/export/csv', array( 'headers' => $headers, 'json' => $request_body, ) @@ -38040,9 +38716,9 @@vulnerabilities_by_severity
// ... -URL obj = new URL("/api/auth/vulns/severities"); +
-URL obj = new URL("/api/auth/vulns/export/csv"); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); +con.setRequestMethod("POST"); int responseCode = con.getResponseCode(); BufferedReader in = new BufferedReader( new InputStreamReader(con.getInputStream())); @@ -38064,12 +38740,13 @@
vulnerabilities_by_severity
func main() { headers := map[string][]string{ + "Content-Type": []string{"application/json"}, "Accept": []string{"application/json"}, "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"}, } data := bytes.NewBuffer([]byte{jsonReq}) - req, err := http.NewRequest("GET", "/api/auth/vulns/severities", data) + req, err := http.NewRequest("POST", "/api/auth/vulns/export/csv", data) req.Header = headers client := &http.Client{} @@ -38078,11 +38755,118 @@vulnerabilities_by_severity
}+
GET /api/auth/vulns/severities
-
POST /api/auth/vulns/export/csv
Get severities for all vulns.
+Export vulnerabilities as CSV.
-:return 200: Success
+++Body parameter
+{ + "patrowl_id": -2147483648, + "asset": 0, + "organization": 0, + "severity": 0, + "cvss_vector": "string", + "status": "new", + "title": "string", + "description": "string", + "description_html": "string", + "source": "string", + "external_id": { + "property1": null, + "property2": null + }, + "category": "string", + "business_impacts": [ + "string" + ], + "has_exploit": true, + "solution_headline": "string", + "solution": "string", + "solution_html": "string", + "solution_priority": "urgent", + "solution_effort": "low", + "solution_gain": -2147483648, + "owners": [ + 0 + ], + "solution_duedate": "2019-08-24T14:15:22Z", + "is_quickwin": true, + "is_auto": true, + "is_greybox": true, + "remediation_date": "2019-08-24T14:15:22Z", + "last_status_update": "2019-08-24T14:15:22Z", + "found_at": "2019-08-24T14:15:22Z", + "last_checked_at": "2019-08-24T14:15:22Z", + "created_at": "2019-08-24T14:15:22Z", + "updated_at": "2019-08-24T14:15:22Z", + "ticketstatus": -2147483648, + "solution_owners": [ + 0 + ], + "updated_by_user_at": "2019-08-24T14:15:22Z" +} +
+patrowl_id: -2147483648 +asset: 0 +organization: 0 +severity: 0 +cvss_vector: string +status: new +title: string +description: string +description_html: string +source: string +external_id: + ? property1 + ? property2 +category: string +business_impacts: + - string +has_exploit: true +solution_headline: string +solution: string +solution_html: string +solution_priority: urgent +solution_effort: low +solution_gain: -2147483648 +owners: + - 0 +solution_duedate: 2019-08-24T14:15:22Z +is_quickwin: true +is_auto: true +is_greybox: true +remediation_date: 2019-08-24T14:15:22Z +last_status_update: 2019-08-24T14:15:22Z +found_at: 2019-08-24T14:15:22Z +last_checked_at: 2019-08-24T14:15:22Z +created_at: 2019-08-24T14:15:22Z +updated_at: 2019-08-24T14:15:22Z +ticketstatus: -2147483648 +solution_owners: + - 0 +updated_by_user_at: 2019-08-24T14:15:22Z + +
Parameters
+ ++
+ + +Name +In +Type +Required +Description ++ +body +body +Vulnerability +true +none +Example responses
@@ -38094,7 +38878,7 @@vulnerabilities_by_severity
"property2": null } -Responses
+Responses
-
@@ -38110,9 +38894,21 @@ +Responses
none Inline + +400 +Bad Request +none +BasicResponseWithMessage ++ 403 +Forbidden +none +BasicResponseWithMessage +Response Schema
+Response Schema
Status Code 200
@@ -38139,18 +38935,18 @@Response Schema
-vulnerabilities_severities_over_time
- +vulnerabilities_by_severity
+Code samples
# You can also use wget -curl -X GET /api/auth/vulns/severities/over-time \ +curl -X GET /api/auth/vulns/severities \ -H 'Accept: application/json' \ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' -
GET /api/auth/vulns/severities/over-time HTTP/1.1 +
GET /api/auth/vulns/severities HTTP/1.1 Accept: application/json @@ -38160,7 +38956,7 @@
vulnerabilities_severities_over_ti 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' }; -fetch('/api/auth/vulns/severities/over-time', +fetch('/api/auth/vulns/severities', { method: 'GET', @@ -38180,7 +38976,7 @@
vulnerabilities_severities_over_ti 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -result = RestClient.get '/api/auth/vulns/severities/over-time', +result = RestClient.get '/api/auth/vulns/severities', params: { }, headers: headers @@ -38192,7 +38988,7 @@
vulnerabilities_severities_over_ti 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -r = requests.get('/api/auth/vulns/severities/over-time', headers = headers) +r = requests.get('/api/auth/vulns/severities', headers = headers) print(r.json()) @@ -38211,7 +39007,7 @@
vulnerabilities_severities_over_ti $request_body = array(); try { - $response = $client->request('GET','/api/auth/vulns/severities/over-time', array( + $response = $client->request('GET','/api/auth/vulns/severities', array( 'headers' => $headers, 'json' => $request_body, ) @@ -38225,7 +39021,7 @@
vulnerabilities_severities_over_ti // ... -
URL obj = new URL("/api/auth/vulns/severities/over-time"); +
-URL obj = new URL("/api/auth/vulns/severities"); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod("GET"); int responseCode = con.getResponseCode(); @@ -38254,7 +39050,7 @@
vulnerabilities_severities_over_ti } data := bytes.NewBuffer([]byte{jsonReq}) - req, err := http.NewRequest("GET", "/api/auth/vulns/severities/over-time", data) + req, err := http.NewRequest("GET", "/api/auth/vulns/severities", data) req.Header = headers client := &http.Client{} @@ -38263,9 +39059,9 @@
vulnerabilities_severities_over_ti }
+
GET /api/auth/vulns/severities/over-time
-
GET /api/auth/vulns/severities
Get severities over time.
+Get severities for all vulns.
:return 200: Success
@@ -38279,7 +39075,7 @@vulnerabilities_severities_over_ti "property2": null } -
Responses
+Responses
-
@@ -38297,7 +39093,7 @@ Responses
Response Schema
+Response Schema
Status Code 200
@@ -38324,18 +39120,18 @@Response Schema
To perform this operation, you must be authenticated -vulnerabilities_statistics
- +vulnerabilities_severities_over_time
+Code samples
# You can also use wget -curl -X GET /api/auth/vulns/severities/statistics \ +curl -X GET /api/auth/vulns/severities/over-time \ -H 'Accept: application/json' \ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' -
GET /api/auth/vulns/severities/statistics HTTP/1.1 +
GET /api/auth/vulns/severities/over-time HTTP/1.1 Accept: application/json @@ -38345,7 +39141,7 @@
vulnerabilities_statistics
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' }; -fetch('/api/auth/vulns/severities/statistics', +fetch('/api/auth/vulns/severities/over-time', { method: 'GET', @@ -38365,7 +39161,7 @@vulnerabilities_statistics
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -result = RestClient.get '/api/auth/vulns/severities/statistics', +result = RestClient.get '/api/auth/vulns/severities/over-time', params: { }, headers: headers @@ -38377,7 +39173,7 @@vulnerabilities_statistics
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -r = requests.get('/api/auth/vulns/severities/statistics', headers = headers) +r = requests.get('/api/auth/vulns/severities/over-time', headers = headers) print(r.json()) @@ -38396,7 +39192,7 @@vulnerabilities_statistics
$request_body = array(); try { - $response = $client->request('GET','/api/auth/vulns/severities/statistics', array( + $response = $client->request('GET','/api/auth/vulns/severities/over-time', array( 'headers' => $headers, 'json' => $request_body, ) @@ -38410,7 +39206,7 @@vulnerabilities_statistics
// ... -URL obj = new URL("/api/auth/vulns/severities/statistics"); +
-URL obj = new URL("/api/auth/vulns/severities/over-time"); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod("GET"); int responseCode = con.getResponseCode(); @@ -38439,7 +39235,7 @@
vulnerabilities_statistics
} data := bytes.NewBuffer([]byte{jsonReq}) - req, err := http.NewRequest("GET", "/api/auth/vulns/severities/statistics", data) + req, err := http.NewRequest("GET", "/api/auth/vulns/severities/over-time", data) req.Header = headers client := &http.Client{} @@ -38448,10 +39244,9 @@vulnerabilities_statistics
}+
GET /api/auth/vulns/severities/statistics
-
GET /api/auth/vulns/severities/over-time
Data corresponding to the number of opened and closed vulns on the last 7 days -A key opened and a key closed, and in each key an object with a key total a key increase
+Get severities over time.
:return 200: Success
@@ -38465,7 +39260,7 @@vulnerabilities_statistics
"property2": null } -Responses
+Responses
-
@@ -38483,7 +39278,7 @@ Responses
Response Schema
+Response Schema
Status Code 200
@@ -38510,18 +39305,18 @@Response Schema
-vulnerabilities_times_to_fix
- +vulnerabilities_statistics
+Code samples
# You can also use wget -curl -X GET /api/auth/vulns/times-to-fix \ +curl -X GET /api/auth/vulns/severities/statistics \ -H 'Accept: application/json' \ -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' -
GET /api/auth/vulns/times-to-fix HTTP/1.1 +
GET /api/auth/vulns/severities/statistics HTTP/1.1 Accept: application/json @@ -38531,7 +39326,7 @@
vulnerabilities_times_to_fix
'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' }; -fetch('/api/auth/vulns/times-to-fix', +fetch('/api/auth/vulns/severities/statistics', { method: 'GET', @@ -38551,7 +39346,7 @@vulnerabilities_times_to_fix
'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -result = RestClient.get '/api/auth/vulns/times-to-fix', +result = RestClient.get '/api/auth/vulns/severities/statistics', params: { }, headers: headers @@ -38563,7 +39358,7 @@vulnerabilities_times_to_fix
'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' } -r = requests.get('/api/auth/vulns/times-to-fix', headers = headers) +r = requests.get('/api/auth/vulns/severities/statistics', headers = headers) print(r.json()) @@ -38582,7 +39377,7 @@vulnerabilities_times_to_fix
$request_body = array(); try { - $response = $client->request('GET','/api/auth/vulns/times-to-fix', array( + $response = $client->request('GET','/api/auth/vulns/severities/statistics', array( 'headers' => $headers, 'json' => $request_body, ) @@ -38596,7 +39391,7 @@vulnerabilities_times_to_fix
// ... -URL obj = new URL("/api/auth/vulns/times-to-fix"); +
-URL obj = new URL("/api/auth/vulns/severities/statistics"); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod("GET"); int responseCode = con.getResponseCode(); @@ -38625,7 +39420,7 @@
vulnerabilities_times_to_fix
} data := bytes.NewBuffer([]byte{jsonReq}) - req, err := http.NewRequest("GET", "/api/auth/vulns/times-to-fix", data) + req, err := http.NewRequest("GET", "/api/auth/vulns/severities/statistics", data) req.Header = headers client := &http.Client{} @@ -38634,9 +39429,12 @@vulnerabilities_times_to_fix
}+
GET /api/auth/vulns/times-to-fix
-
GET /api/auth/vulns/severities/statistics
API endpoint that allows Vulnerabilities to be viewed or edited.
+Data corresponding to the number of opened and closed vulns on the last 7 days +A key opened and a key closed, and in each key an object with a key total a key increase
+ +:return 200: Success
Example responses
@@ -38648,7 +39446,7 @@vulnerabilities_times_to_fix
"property2": null } -Responses
+Responses
-
@@ -38664,21 +39462,9 @@ -Responses
none Inline - -400 -Bad Request -none -BasicResponseWithMessage -- 403 -Forbidden -none -BasicResponseWithMessage -Response Schema
+Response Schema
Status Code 200
@@ -38705,102 +39491,202 @@Response Schema
-Schemas
-ArsenalVulnerability
+vulnerabilities_times_to_fix
+ + +++Code samples
+# You can also use wget +curl -X GET /api/auth/vulns/times-to-fix \ + -H 'Accept: application/json' \ + -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345' + +
GET /api/auth/vulns/times-to-fix HTTP/1.1 + +Accept: application/json + +
+const headers = { + 'Accept':'application/json', + 'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345' +}; + +fetch('/api/auth/vulns/times-to-fix', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +
require 'rest-client' +require 'json' + +headers = { + 'Accept' => 'application/json', + 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' +} + +result = RestClient.get '/api/auth/vulns/times-to-fix', + params: { + }, headers: headers + +p JSON.parse(result) + +
import requests +headers = { + 'Accept': 'application/json', + 'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345' +} + +r = requests.get('/api/auth/vulns/times-to-fix', headers = headers) + +print(r.json()) + +
<?php + +require 'vendor/autoload.php'; + +$headers = array( + 'Accept' => 'application/json', + 'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345', +); + +$client = new \GuzzleHttp\Client(); + +// Define array of request body. +$request_body = array(); - +try { + $response = $client->request('GET','/api/auth/vulns/times-to-fix', array( + 'headers' => $headers, + 'json' => $request_body, + ) + ); + print_r($response->getBody()->getContents()); + } + catch (\GuzzleHttp\Exception\BadResponseException $e) { + // handle exception or api errors. + print_r($e->getMessage()); + } + + // ... + +
URL obj = new URL("/api/auth/vulns/times-to-fix"); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod("GET"); +int responseCode = con.getResponseCode(); +BufferedReader in = new BufferedReader( + new InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = new StringBuffer(); +while ((inputLine = in.readLine()) != null) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +
+package main + +import ( + "bytes" + "net/http" +) + +func main() { + + headers := map[string][]string{ + "Accept": []string{"application/json"}, + "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"}, + } + + data := bytes.NewBuffer([]byte{jsonReq}) + req, err := http.NewRequest("GET", "/api/auth/vulns/times-to-fix", data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + // ... +} + +
+ +
GET /api/auth/vulns/times-to-fix
API endpoint that allows Vulnerabilities to be viewed or edited.
+ ++Example responses
+ +200 Response
+-{ - "id": 0, - "title": "string", - "description": "string", - "severity": 0, - "solution_priority": "urgent", - "solution_effort": "low", - "cvss_vector": "string", - "solution_headline": "string", - "solution": "string" + "property1": null, + "property2": null } -
Serializer for Arsenal Vulnerabilities
-Properties
+Responses
++ +
- Name -Type -Required -Restrictions +Status +Meaning Description +Schema - -id -integer -true -read-only -none -- -title -string¦null -false -none -none -- -description -string -false -none -none -- -severity -SeverityEnum -false -none -none -- solution_priority -SolutionPriorityEnum -false -none +200 +OK none +Inline - solution_effort -SolutionEffortEnum -false -none +400 +Bad Request none +BasicResponseWithMessage - +cvss_vector -string¦null -false -none +403 +Forbidden none +BasicResponseWithMessage Response Schema
+ +Status Code 200
+ +Unspecified response body
+ ++ +
- +solution_headline -string¦null -false -none -none +Name +Type +Required +Restrictions +Description - solution -string +» additionalProperties +any false none none Schemas
Asset
Asset
0 ], "security_checks": "string", - "monitored_slot_lock_until": "2019-08-24T14:15:22Z" + "monitored_slot_lock_until": "2019-08-24T14:15:22Z", + "is_up": true }Asset DRF Serializer definition.
-Properties
+Properties
+ Name @@ -39060,6 +39947,13 @@Properties
read-only none + is_up +boolean +true +read-only +none +AssetGroup
@@ -39088,12 +39982,13 @@AssetGroup
0 ], "is_dynamic": true, - "filters": "string" + "filters": "string", + "criticality": 1 }AssetGroup DRF Serializer definition.
-Properties
+Properties
+ Name @@ -39201,6 +40096,13 @@Properties
read-only none + criticality +CriticalityEnum +false +none +none +AssetInList
@@ -39229,12 +40131,13 @@AssetInList
"organization": 0, "last_checked_at": "string", "score_level": "string", - "asset_owners": "string" + "asset_owners": "string", + "is_up": true }Asset DRF Serializer definition.
-Properties
+Properties
+ Name @@ -39384,6 +40287,13 @@Properties
read-only none + is_up +boolean +false +none +none +AssetTag
@@ -39400,7 +40310,7 @@AssetTag
AssetTag DRF Serializer definition.
-Properties
+Properties
Name @@ -39448,7 +40358,7 @@Banner
Serializer for Banner endpoint.
-Properties
+Properties
Name @@ -39498,7 +40408,7 @@BasicResponse
"status": "string" } -Properties
+Properties
Name @@ -39528,7 +40438,7 @@BasicResponseWithMessage
"message": "string" } -Properties
+Properties
Name @@ -39581,7 +40491,7 @@Certificate
Serializer for Certificate endpoint.
-Properties
+Properties
Name @@ -39707,7 +40617,7 @@CertificateLite
Lite Serializer for Certificate endpoint.
-Properties
+Properties
Name @@ -39790,7 +40700,7 @@Control
Serializer for Control endpoint.
-Properties
+Properties
Name @@ -39948,7 +40858,7 @@ControlAsset
Serializer for Control's asset
-Properties
+Properties
Name @@ -40007,7 +40917,7 @@ControlLite
Serializer for Control endpoint.
-Properties
+Properties
Name @@ -40147,7 +41057,7 @@ControlVulnerability
Serializer for Control's vulnerability
-Properties
+Properties
Name @@ -40202,7 +41112,7 @@CriticalityEnum
1 -
Properties
+Properties
Name @@ -40259,7 +41169,7 @@Cybelangel
CybelangelConfig serializer definition
-Properties
+Properties
Name @@ -40393,7 +41303,7 @@Domain
Serializer for Domain endpoint.
-Properties
+Properties
+
Name @@ -40517,7 +41427,7 @@DomainLite
Lite Serializer for Domain endpoint.
-Properties
+Properties
+ Name @@ -40583,7 +41493,7 @@DomainWhoIsRecord
Serializer for DomainWhoisRecord endpoint.
-Properties
+Properties
+
Name @@ -40707,6 +41617,127 @@Properties
DownloadReporting
+ + +{ + "emails": [ + "user@example.com" + ], + "assets": [ + 0 + ], + "vulnerabilities": [ + 0 + ], + "assetgroups": [ + 0 + ], + "assets_from_assetgroups": [ + 0 + ], + "vulnerabilities_from_assetgroups": [ + 0 + ], + "pentests": [ + 0 + ], + "assets_from_pentests": [ + 0 + ], + "vulnerabilities_from_pentests": [ + 0 + ], + "suborganizations": [ + 0 + ] +} + +
Properties
++
++ + +Name +Type +Required +Restrictions +Description ++ +emails +[string] +false +none +none ++ +assets +[integer] +false +none +none ++ +vulnerabilities +[integer] +false +none +none ++ +assetgroups +[integer] +false +none +none ++ +assets_from_assetgroups +[integer] +false +none +none ++ +vulnerabilities_from_assetgroups +[integer] +false +none +none ++ +pentests +[integer] +false +none +none ++ +assets_from_pentests +[integer] +false +none +none ++ +vulnerabilities_from_pentests +[integer] +false +none +none ++ +suborganizations +[integer] +false +none +none +EventComment
EventComment
"message": "string", "author": "user@example.com", "text": "string", - "scope": "string" + "scope": "string", + "updated_at": "2019-08-24T14:15:22Z", + "is_editable": "string" } @@ -40776,6 +41809,20 @@Properties
none none + +updated_at +string(date-time) +true +none +none ++ is_editable +string +true +read-only +none +ExposureEnum
@@ -40829,6 +41876,101 @@Enumerated Values
ExternalVulnerability
+ + ++{ + "id": 0, + "title": "string", + "description": "string", + "severity": 0, + "solution_priority": "urgent", + "solution_effort": "low", + "cvss_vector": "string", + "solution_headline": "string", + "solution": "string" +} + +
Serializer for ExternalV Vulnerabilities
+Properties
++
++ + +Name +Type +Required +Restrictions +Description ++ +id +integer +true +read-only +none ++ +title +string¦null +false +none +none ++ +description +string +false +none +none ++ +severity +SeverityEnum +false +none +none ++ +solution_priority +SolutionPriorityEnum +false +none +none ++ +solution_effort +SolutionEffortEnum +false +none +none ++ +cvss_vector +string¦null +false +none +none ++ +solution_headline +string¦null +false +none +none ++ +solution +string +false +none +none +Feed
Feed
Serializer for Alert endpoint.
-Properties
+Properties
Name @@ -40961,7 +42103,7 @@FeedTypeEnum
"Control" -
Properties
+Properties
Name @@ -41052,7 +42194,7 @@IPAddress
Serializer for IPAddress endpoint.
-Properties
+Properties
Name @@ -41170,7 +42312,7 @@IPAddressLite
Lite Serializer for IPAddress endpoint.
-Properties
+Properties
Name @@ -41218,7 +42360,7 @@IPAddressTypeEnum
"ipv4" -
Properties
+Properties
Name @@ -41270,7 +42412,7 @@IPGeneralInfo
Serializer for IPGeneralInfo endpoint.
-Properties
+Properties
Name @@ -41332,7 +42474,7 @@LevelEnum
"Information" -
Properties
+Properties
Name @@ -41414,12 +42556,13 @@PaginatedAssetGroupList
0 ], "is_dynamic": true, - "filters": "string" + "filters": "string", + "criticality": 1 } ] } -Properties
+Properties
Name @@ -41490,12 +42633,13 @@PaginatedAssetInListList
"organization": 0, "last_checked_at": "string", "score_level": "string", - "asset_owners": "string" + "asset_owners": "string", + "is_up": true } ] } -Properties
+Properties
Name @@ -41581,12 +42725,13 @@PaginatedAssetList
0 ], "security_checks": "string", - "monitored_slot_lock_until": "2019-08-24T14:15:22Z" + "monitored_slot_lock_until": "2019-08-24T14:15:22Z", + "is_up": true } ] } -Properties
+Properties
Name @@ -41645,7 +42790,7 @@PaginatedAssetTagList
] } -Properties
+Properties
Name @@ -41717,7 +42862,7 @@PaginatedCertificateList
] } -Properties
+Properties
Name @@ -41795,7 +42940,7 @@PaginatedControlLiteList
] } -Properties
+Properties
Name @@ -41858,7 +43003,7 @@PaginatedCybelangelList
] } -Properties
+Properties
Name @@ -41976,7 +43121,7 @@PaginatedDomainList
] } -Properties
+Properties
Name @@ -42033,12 +43178,14 @@PaginatedEventCommentList
"message": "string", "author": "user@example.com", "text": "string", - "scope": "string" + "scope": "string", + "updated_at": "2019-08-24T14:15:22Z", + "is_editable": "string" } ] } -Properties
+Properties
Name @@ -42118,7 +43265,7 @@PaginatedFeedList
] } -Properties
+Properties
Name @@ -42215,7 +43362,7 @@PaginatedIPAddressList
] } -Properties
+Properties
Name @@ -42288,7 +43435,7 @@PaginatedPentestList
] } -Properties
+Properties
Name @@ -42376,7 +43523,7 @@PaginatedPortList
] } -Properties
+Properties
Name @@ -42429,7 +43576,7 @@PaginatedRetestList
"results": [ { "id": 0, - "arsenal_id": 0, + "patrowl_id": 0, "vulnerability": 0, "status": "none", "comments": "string", @@ -42441,7 +43588,7 @@PaginatedRetestList
] } -Properties
+Properties
Name @@ -42505,7 +43652,7 @@PaginatedTicketList
] } -Properties
+Properties
Name @@ -42558,6 +43705,8 @@PaginatedVulnerabilityLiteList
"results": [ { "id": 0, + "user_friendly_id": "string", + "description": "string", "solution_headline": "string", "solution_priority": "urgent", "solution_effort": "low", @@ -42575,12 +43724,14 @@PaginatedVulnerabilityLiteList
"reteststatus": "string", "ticketstatus": -2147483648, "is_retestable": true, - "last_ticket": "string" + "last_ticket": "string", + "solution_duedate": "2019-08-24T14:15:22Z", + "created_at": "2019-08-24T14:15:22Z" } ] } -Properties
+Properties
Name @@ -42674,7 +43825,7 @@PaginatedWebServerList
] } -Properties
+Properties
Name @@ -42755,12 +43906,13 @@PatchedAsset
0 ], "security_checks": "string", - "monitored_slot_lock_until": "2019-08-24T14:15:22Z" + "monitored_slot_lock_until": "2019-08-24T14:15:22Z", + "is_up": true }Asset DRF Serializer definition.
-Properties
+Properties
+ Name @@ -42973,6 +44125,13 @@Properties
read-only none + is_up +boolean +false +read-only +none +PatchedAssetGroup
@@ -43001,12 +44160,13 @@PatchedAssetGroup
0 ], "is_dynamic": true, - "filters": "string" + "filters": "string", + "criticality": 1 }AssetGroup DRF Serializer definition.
-Properties
+Properties
+ Name @@ -43114,6 +44274,13 @@Properties
read-only none + criticality +CriticalityEnum +false +none +none +PatchedAssetTag
@@ -43130,7 +44297,7 @@PatchedAssetTag
AssetTag DRF Serializer definition.
-Properties
+Properties
Name @@ -43181,7 +44348,7 @@PatchedCybelangel
CybelangelConfig serializer definition
-Properties
+Properties
Name @@ -43270,7 +44437,7 @@PatchedPentest
Serializer for Pentest endpoint.
-Properties
+Properties
Name @@ -43396,7 +44563,7 @@PatchedVulnerability
{ "id": 0, "user_friendly_id": "string", - "arsenal_id": -2147483648, + "patrowl_id": -2147483648, "asset": 0, "asset_id": "string", "organization": 0, @@ -43449,7 +44616,7 @@
PatchedVulnerability
0 ], "suborganizations": "string", - "arsenal_vulnerability": { + "external_vulnerability": { "id": 0, "title": "string", "description": "string", @@ -43469,7 +44636,7 @@PatchedVulnerability
Serializer for Vulnerability endpoint.
-Properties
+Properties
Name @@ -43494,7 +44661,7 @@Properties
none - arsenal_id +patrowl_id integer¦null false none @@ -43809,11 +44976,11 @@Properties
none - arsenal_vulnerability -ArsenalVulnerability +external_vulnerability +ExternalVulnerability false read-only -Serializer for Arsenal Vulnerabilities +Serializer for ExternalV Vulnerabilities last_updated_by @@ -43844,7 +45011,7 @@Patchedbulk_update_vulns_status"status": "new" } -
Properties
+Properties
Name @@ -43884,7 +45051,7 @@Patchedserializer_ass "is_monitored": true } -
Properties
+Properties
Name @@ -43945,7 +45112,7 @@Pentest
Serializer for Pentest endpoint.
-Properties
+Properties
Name @@ -44105,7 +45272,7 @@Port
Serializer for Port endpoint.
-Properties
+Properties
Name @@ -44212,7 +45379,7 @@PortLite
Lite serializer for Port endpoint.
-Properties
+Properties
Name @@ -44281,7 +45448,7 @@ProtocolEnum
"tcp" -
Properties
+Properties
Name @@ -44324,7 +45491,7 @@Retest
{ "id": 0, - "arsenal_id": 0, + "patrowl_id": 0, "vulnerability": 0, "status": "none", "comments": "string", @@ -44336,7 +45503,7 @@
Retest
Serializer for Retest endpoint.
-Properties
+Properties
Name @@ -44354,7 +45521,7 @@Properties
none - arsenal_id +patrowl_id integer true read-only @@ -44419,7 +45586,7 @@RetestStatusEnum
"none" -
Properties
+Properties
Name @@ -44482,7 +45649,7 @@SeverityEnum
0 -
Properties
+Properties
Name @@ -44537,7 +45704,7 @@SolutionEffortEnum
"low" -
Properties
+Properties
Name @@ -44584,7 +45751,7 @@SolutionPriorityEnum
"urgent" -
Properties
+Properties
Name @@ -44631,7 +45798,7 @@StateEnum
"open" -
Properties
+Properties
Name @@ -44682,7 +45849,7 @@Status0cbEnum
"new" -
Properties
+Properties
Name @@ -44759,7 +45926,7 @@Success
"score": "string" } -Properties
+Properties
Name @@ -44797,7 +45964,7 @@Ticket
Serializer for Ticket endpoint.
-Properties
+Properties
Name @@ -44873,7 +46040,7 @@TicketStatusEnum
0 -
Properties
+Properties
Name @@ -44936,7 +46103,7 @@TypeDd0Enum
"ip" -
Properties
+Properties
Name @@ -45000,7 +46167,7 @@Vulnerability
{ "id": 0, "user_friendly_id": "string", - "arsenal_id": -2147483648, + "patrowl_id": -2147483648, "asset": 0, "asset_id": "string", "organization": 0, @@ -45053,7 +46220,7 @@
Vulnerability
0 ], "suborganizations": "string", - "arsenal_vulnerability": { + "external_vulnerability": { "id": 0, "title": "string", "description": "string", @@ -45073,7 +46240,7 @@Vulnerability
Serializer for Vulnerability endpoint.
-Properties
+Properties
Name @@ -45098,7 +46265,7 @@Properties
none - arsenal_id +patrowl_id integer¦null false none @@ -45413,11 +46580,11 @@Properties
none - arsenal_vulnerability -ArsenalVulnerability +external_vulnerability +ExternalVulnerability true read-only -Serializer for Arsenal Vulnerabilities +Serializer for ExternalV Vulnerabilities last_updated_by @@ -45443,6 +46610,8 @@VulnerabilityLite
{ "id": 0, + "user_friendly_id": "string", + "description": "string", "solution_headline": "string", "solution_priority": "urgent", "solution_effort": "low", @@ -45460,12 +46629,14 @@
VulnerabilityLite
"reteststatus": "string", "ticketstatus": -2147483648, "is_retestable": true, - "last_ticket": "string" + "last_ticket": "string", + "solution_duedate": "2019-08-24T14:15:22Z", + "created_at": "2019-08-24T14:15:22Z" }Lite Serializer for Vulnerability endpoint.
-Properties
+Properties
Name @@ -45483,6 +46654,20 @@Properties
none + +user_friendly_id +string +true +read-only +none ++ +description +string +false +none +none ++ solution_headline string¦null false @@ -45608,6 +46793,20 @@Properties
read-only none + +solution_duedate +string(date-time)¦null +false +none +none ++ created_at +string(date-time) +false +none +none +VulnerabilityUser
@@ -45621,7 +46820,7 @@VulnerabilityUser
"email": "user@example.com" } -Properties
+Properties
Name @@ -45672,7 +46871,7 @@WebPortLite
Lite serializer for Port endpoint.
-Properties
+Properties
Name @@ -45782,7 +46981,7 @@WebServer
Serializer for WebServer endpoint.
-Properties
+Properties
Name @@ -45942,7 +47141,7 @@WebServerLite
Lite Serializer for WebServer endpoint.
-Properties
+Properties
Name @@ -45994,7 +47193,7 @@add_owners
] } -Properties
+Properties
Name @@ -46025,7 +47224,7 @@assets_group_add_assets
] } -Properties
+Properties
Name @@ -46054,7 +47253,7 @@assets_group_add_tag
"value": "string" } -Properties
+Properties
Name @@ -46088,7 +47287,7 @@create_asset
"exposure": "unknown" } -Properties
+Properties
Name @@ -46157,7 +47356,7 @@response_assets_group_add_tag
} } -Properties
+Properties
Name @@ -46193,7 +47392,7 @@retests_update_comment
"comment": "string" } -Properties
+Properties
Name @@ -46223,7 +47422,7 @@upload_file_attachements
"file": "http://example.com" } -Properties
+Properties
Name