From d93710848dde2823797428aba73d4068d000fd6a Mon Sep 17 00:00:00 2001 From: SApatrowl-github Date: Thu, 31 Oct 2024 12:38:43 +0000 Subject: [PATCH] 2024-10-31T12:37:10: Update API doc --- index.html | 888 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 720 insertions(+), 168 deletions(-) diff --git a/index.html b/index.html index 0a1ee65..54bcb73 100644 --- a/index.html +++ b/index.html @@ -926,6 +926,9 @@
  • report_create
    • +
  • + report_care_rating_retrieve +
  • report_fast_create
    • @@ -1432,6 +1435,12 @@
  • InsightPolymorphic
    • +
  • + InsightSubTopic +
    • +
  • + InsightTopic +
  • LevelEnum
    • @@ -41656,6 +41665,166 @@

    Responses

    + +

    report_care_rating_retrieve

    +

    + +
    +

    Code samples

    +
    +
    # You can also use wget
+curl -X GET https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating \
+  -H 'Authorization: Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+
+
    GET https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating HTTP/1.1
+Host: dashboard.cloud.patrowl.io
+
+
    
+const headers = {
+  'Authorization':'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+};
+
+fetch('https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
    require 'rest-client'
+require 'json'
+
+headers = {
+  'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+result = RestClient.get 'https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+
    import requests
+headers = {
+  'Authorization': 'Token 1234567890abcefghijklmnopqrstuvwxyz12345'
+}
+
+r = requests.get('https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating', headers = headers)
+
+print(r.json())
+
+
    <?php
+
+require 'vendor/autoload.php';
+
+$headers = array(
+    'Authorization' => 'Token 1234567890abcefghijklmnopqrstuvwxyz12345',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+    $response = $client->request('GET','https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating', 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("https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating");
+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{
+        "Authorization": []string{"Token 1234567890abcefghijklmnopqrstuvwxyz12345"},
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "https://dashboard.cloud.patrowl.io/api/auth/report/{org_id}/care/rating", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+
    +

    GET /api/auth/report/{org_id}/care/rating

    + +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameInTypeRequiredDescription
    org_idpathintegertruenone
    + +

    Responses

    + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKNo response bodyNone
    + @@ -43372,13 +43541,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -43442,9 +43619,15 @@

    risks_update

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } }    '; const headers = { @@ -43570,18 +43753,28 @@

    risks_update

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } } 
    resourcetype: string
 light_description: string
 severity: 0
 status: 0
+subtopic:
+  title: string
 asset:
   value: string
   is_monitored: true
+topic:
+  title: string

    Parameters

    @@ -43616,13 +43809,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -43820,13 +44021,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -43888,9 +44097,15 @@

    risks_partial_update

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } }    '; const headers = { @@ -44016,18 +44231,28 @@

    risks_partial_update

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } } 
    resourcetype: string
 light_description: string
 severity: 0
 status: 0
+subtopic:
+  title: string
 asset:
   value: string
   is_monitored: true
+topic:
+  title: string

    Parameters

    @@ -44069,13 +44294,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -44273,13 +44506,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -44457,13 +44698,21 @@

    risks_by_severity_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -44641,13 +44890,21 @@

    risks_count_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -44825,13 +45082,21 @@

    risks_export_csv_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -44893,9 +45158,15 @@

    risks_export_csv_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } }    '; const headers = { @@ -45021,18 +45292,28 @@

    risks_export_csv_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } } 
    resourcetype: string
 light_description: string
 severity: 0
 status: 0
+subtopic:
+  title: string
 asset:
   value: string
   is_monitored: true
+topic:
+  title: string

    Parameters

    @@ -45067,13 +45348,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -45251,13 +45540,21 @@

    risks_export_json_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -45319,9 +45616,15 @@

    risks_export_json_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } }    '; const headers = { @@ -45447,18 +45750,28 @@

    risks_export_json_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } } 
    resourcetype: string
 light_description: string
 severity: 0
 status: 0
+subtopic:
+  title: string
 asset:
   value: string
   is_monitored: true
+topic:
+  title: string

    Parameters

    @@ -45493,13 +45806,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -45677,13 +45998,21 @@

    risks_over_time_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -47915,13 +48244,21 @@

    risks_statistics_retrieve

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -48389,9 +48726,15 @@

    risks_vulns_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } }    '; const headers = { @@ -48509,6 +48852,14 @@

    risks_vulns_create

    POST /api/auth/risks/vulns/

    +

    Create vulnerabilities from risk insights on demand of the user.

    + +

    Args: + request (type): Request parameters.

    + +

    Returns: + Response: API response

    +

    Body parameter

    @@ -48517,18 +48868,28 @@

    risks_vulns_create

    "light_description": "string", "severity": 0, "status": 0, + "subtopic": { + "title": "string" + }, "asset": { "value": "string", "is_monitored": true + }, + "topic": { + "title": "string" } } 
    resourcetype: string
 light_description: string
 severity: 0
 status: 0
+subtopic:
+  title: string
 asset:
   value: string
   is_monitored: true
+topic:
+  title: string

    Parameters

    @@ -48563,13 +48924,21 @@

    Parameters

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -54203,7 +54572,13 @@

    users_destroy

    DELETE /api/auth/users/

    -

    API endpoint that allows Users to be viewed or edited.

    +

    Delete one or many users.

    + +

    Args: + request (type):

    + +

    Returns: + Response: Http response

    Responses

    @@ -58454,6 +58829,7 @@

    vulns_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -58614,6 +58990,7 @@

    vulns_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -58653,6 +59030,7 @@

    vulns_create

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -58721,7 +59099,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -59328,7 +59706,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -59427,6 +59805,7 @@

    vulns_partial_update

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -59587,6 +59966,7 @@

    vulns_partial_update

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -59626,6 +60006,7 @@

    vulns_partial_update

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -59701,7 +60082,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -59896,7 +60277,13 @@

    vulns_destroy_2

    DELETE /api/auth/vulns/{id}/

    -

    API endpoint that allows Vulnerabilities to be viewed or edited.

    +

    Delete a Vulnerability if it was not created by Patrowl or by a Risk Insight.

    + +

    Args: + request (type):Request parameters

    + +

    Returns: + Response: API response

    Parameters

    @@ -60210,6 +60597,7 @@

    vulnerabilities_create_comment

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -60374,6 +60762,7 @@

    vulnerabilities_create_comment

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -60413,6 +60802,7 @@

    vulnerabilities_create_comment

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -60578,6 +60968,7 @@

    vulnerabilities_edit_comment

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -60742,6 +61133,7 @@

    vulnerabilities_edit_comment

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -60781,6 +61173,7 @@

    vulnerabilities_edit_comment

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -61897,6 +62290,7 @@

    vulns_owners_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -62057,6 +62451,7 @@

    vulns_owners_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -62096,6 +62491,7 @@

    vulns_owners_create

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -62171,7 +62567,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -63843,6 +64239,7 @@

    vulns_solution_owners_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -64003,6 +64400,7 @@

    vulns_solution_owners_create

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -64042,6 +64440,7 @@

    vulns_solution_owners_create

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -64117,7 +64516,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -65463,7 +65862,7 @@

    Parameters

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -66748,6 +67147,7 @@

    vulnerabilities_export_csv_2

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -66908,6 +67308,7 @@

    vulnerabilities_export_csv_2

    "organization": 0, "severity": 0, "cvss_vector": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -66947,6 +67348,7 @@

    vulnerabilities_export_csv_2

    organization: 0 severity: 0 cvss_vector: string +cvss_score: 10 status: new title: string description: string @@ -71457,13 +71859,21 @@

    InsightBase

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -71531,10 +71941,10 @@

    Properties

    subtopic -string +InsightSubTopic true -read-only none +Serializer for SubTopic Serializer definition. asset @@ -71545,10 +71955,10 @@

    Properties

    topic -string +InsightTopic true -read-only none +Serializer for Topic DRF Serializer definition. created_at @@ -71755,13 +72165,21 @@

    InsightBaseTyped

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -71961,13 +72379,21 @@

    InsightPolymorphic

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -71989,6 +72415,100 @@

    InsightPolymorphic

    Properties

    None

    +

    InsightSubTopic

    + +

    + + +

    +
    {
+  "id": 0,
+  "title": "string",
+  "slug": "string"
+}
+
+
    +

    Serializer for SubTopic Serializer definition.

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    idintegertrueread-onlynone
    titlestringtruenonenone
    slugstringtrueread-onlynone
    + +

    InsightTopic

    + +

    + + +

    +
    {
+  "id": 0,
+  "title": "string",
+  "slug": "string"
+}
+
+
    +

    Serializer for Topic DRF Serializer definition.

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    idintegertrueread-onlynone
    titlestringtruenonenone
    slugstringtrueread-onlynone
    +

    LevelEnum

    @@ -72006,7 +72526,7 @@

    LevelEnum

  • Warning - Warning
  • Predictive - Predictive
    • -

    Properties

    +

    Properties

    @@ -72071,7 +72591,7 @@

    LivenessEnum

  • up - Up
  • down - Down
    • -

    Properties

    +

    Properties

    Name
    @@ -72118,7 +72638,7 @@

    NullEnum

    null
 
-

    Properties

    +

    Properties

    None

    Organization

    @@ -72149,7 +72669,7 @@

    Organization

    Serializer for Organization endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -72297,7 +72817,7 @@

    OrganizationSetting

    Serializer for OrganizationSetting endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -72374,7 +72894,7 @@

    OrganizationUser

    Serializer for Organization User endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -72483,7 +73003,7 @@

    PaginatedAssetGroupLiteList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72558,7 +73078,7 @@

    PaginatedAssetInListList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72617,7 +73137,7 @@

    PaginatedAssetTagList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72683,7 +73203,7 @@

    PaginatedAutoTagPolicyList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72752,7 +73272,7 @@

    PaginatedCertificateList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72813,7 +73333,7 @@

    PaginatedCommentList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72891,7 +73411,7 @@

    PaginatedControlLiteList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -72954,7 +73474,7 @@

    PaginatedCybelangelList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73063,7 +73583,7 @@

    PaginatedDomainList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73127,7 +73647,7 @@

    PaginatedEventCommentList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73207,7 +73727,7 @@

    PaginatedFeedList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73303,7 +73823,7 @@

    PaginatedIPAddressList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73374,7 +73894,7 @@

    PaginatedInsightPolicyList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73432,13 +73952,21 @@

    PaginatedInsightPolymorphicList"light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -73459,7 +73987,7 @@

    PaginatedInsightPolymorphicList] } -

    Properties

    +

    Properties

    Name
    @@ -73532,7 +74060,7 @@

    PaginatedOrganizationList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73594,7 +74122,7 @@

    PaginatedOrganizationSettingList< ] } -

    Properties

    +

    Properties

    Name
    @@ -73662,7 +74190,7 @@

    PaginatedOrganizationUserList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73735,7 +74263,7 @@

    PaginatedPentestList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73823,7 +74351,7 @@

    PaginatedPortList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -73892,7 +74420,7 @@

    PaginatedReadGreyboxRequestList] } -

    Properties

    +

    Properties

    Name
    @@ -73969,7 +74497,7 @@

    PaginatedRemediationList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74034,7 +74562,7 @@

    PaginatedRetestList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74094,7 +74622,7 @@

    PaginatedScanInListList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74162,7 +74690,7 @@

    PaginatedSubOrganizationUserList< ] } -

    Properties

    +

    Properties

    Name
    @@ -74231,7 +74759,7 @@

    PaginatedSubOrganizationsInLis ] } -

    Properties

    +

    Properties

    Name
    @@ -74291,7 +74819,7 @@

    PaginatedSubOrganizationsListLis ] } -

    Properties

    +

    Properties

    Name
    @@ -74357,7 +74885,7 @@

    PaginatedSubTopicList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74421,7 +74949,7 @@

    PaginatedTicketList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74495,7 +75023,7 @@

    PaginatedTopicList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74583,7 +75111,7 @@

    PaginatedUserList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74663,7 +75191,7 @@

    PaginatedVulnerabilityLiteList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74756,7 +75284,7 @@

    PaginatedWebServerList

    ] } -

    Properties

    +

    Properties

    Name
    @@ -74844,7 +75372,7 @@

    PatchedAsset

    Asset DRF Serializer definition.

    -

    Properties

    +

    Properties

    Name
    @@ -75105,7 +75633,7 @@

    PatchedAssetGroup

    AssetGroup DRF Serializer definition.

    -

    Properties

    +

    Properties

    Name
    @@ -75236,7 +75764,7 @@

    PatchedAssetTag

    AssetTag DRF Serializer definition.

    -

    Properties

    +

    Properties

    Name
    @@ -75287,7 +75815,7 @@

    PatchedCybelangel

    CybelangelConfig serializer definition

    -

    Properties

    +

    Properties

    Name
    @@ -75360,13 +75888,21 @@

    PatchedInsightBase

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -75387,7 +75923,7 @@

    PatchedInsightBase

    Serializer for Insight endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -75434,10 +75970,10 @@

    Properties

    - + - + @@ -75448,10 +75984,10 @@

    Properties

    - + - + @@ -75580,13 +76116,21 @@

    PatchedInsightBaseTyped

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -75605,7 +76149,7 @@

    PatchedInsightBaseTyped

    "protocol": "string" } -

    Properties

    +

    Properties

    allOf

    Name
    subtopicstringInsightSubTopic falseread-only noneSerializer for SubTopic Serializer definition.
    asset
    topicstringInsightTopic falseread-only noneSerializer for Topic DRF Serializer definition.
    created_at
    @@ -75677,7 +76221,7 @@

    PatchedInsightPolicy

    "already_applied": true } -

    Properties

    +

    Properties

    @@ -75786,13 +76330,21 @@

    PatchedInsightPolymorphic

    "light_description": "string", "severity": 0, "status": 0, - "subtopic": "string", + "subtopic": { + "id": 0, + "title": "string", + "slug": "string" + }, "asset": { "id": 0, "value": "string", "is_monitored": true }, - "topic": "string", + "topic": { + "id": 0, + "title": "string", + "slug": "string" + }, "created_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "serial_number": "string", @@ -75811,7 +76363,7 @@

    PatchedInsightPolymorphic

    "protocol": "string" } -

    Properties

    +

    Properties

    None

    PatchedPentest

    @@ -75842,7 +76394,7 @@

    PatchedPentest

    Serializer for Pentest endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -76005,7 +76557,7 @@

    PatchedRemediation

    Serializer for Remediation endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -76148,7 +76700,7 @@

    PatchedUpdateAutoTagPolicy

    "updated_at": "2019-08-24T14:15:22Z" } -

    Properties

    +

    Properties

    Name
    @@ -76254,7 +76806,7 @@

    PatchedUpdateInsightPolicy

    "already_applied": true } -

    Properties

    +

    Properties

    Name
    @@ -76367,7 +76919,7 @@

    PatchedVulnerability

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -76430,7 +76982,7 @@

    PatchedVulnerability

    Serializer for Vulnerability endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -76512,9 +77064,9 @@

    Properties

    - + - + @@ -76805,7 +77357,7 @@

    Patchedbulk_update_vulns_status"status": "new" } -

    Properties

    +

    Properties

    Name
    cvss_scorestringnumber(double) falseread-onlynone none
    @@ -76845,7 +77397,7 @@

    Patchedserializer_ass "is_monitored": true } -

    Properties

    +

    Properties

    Name
    @@ -76906,7 +77458,7 @@

    Pentest

    Serializer for Pentest endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -77080,7 +77632,7 @@

    Port

    Serializer for Port endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -77187,7 +77739,7 @@

    PortLite

    Lite serializer for Port endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -77262,7 +77814,7 @@

    PriorityEnum

  • moderate - Moderate
  • hardening - Hardening
    • -

    Properties

    +

    Properties

    Name
    @@ -77314,7 +77866,7 @@

    ProtocolEnum

  • tcp - TCP
  • udp - UDP
    • -

    Properties

    +

    Properties

    Name
    @@ -77373,7 +77925,7 @@

    ReadGreyboxRequest

    Serializer for Greybox Request class

    -

    Properties

    +

    Properties

    Name
    @@ -77508,7 +78060,7 @@

    Remediation

    Serializer for Remediation endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -77646,7 +78198,7 @@

    RemediationEffortEnum

  • 1 - Medium
  • 2 - High
    • -

    Properties

    +

    Properties

    Name
    @@ -77701,7 +78253,7 @@

    RemediationPriorityEnum

  • 3 - High
  • 4 - Critical
    • -

    Properties

    +

    Properties

    Name
    @@ -77768,7 +78320,7 @@

    Retest

    Serializer for Retest endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -77861,7 +78413,7 @@

    RetestStatusEnum

  • error - Error
  • canceled - Canceled
    • -

    Properties

    +

    Properties

    Name
    @@ -77930,7 +78482,7 @@

    RoleEnum

  • 3 - Auditor
  • 4 - Organization Admin
    • -

    Properties

    +

    Properties

    Name
    @@ -77982,7 +78534,7 @@

    ScanInList

    "assets": "string" } -

    Properties

    +

    Properties

    Name
    @@ -78035,7 +78587,7 @@

    ScanTypeEnum

  • passive - Passive
  • offensive - Offensive
    • -

    Properties

    +

    Properties

    Name
    @@ -78088,7 +78640,7 @@

    SecurityCheck

    "webservers_required": true } -

    Properties

    +

    Properties

    Name
    @@ -78177,7 +78729,7 @@

    SolutionEffortEnum

  • medium - Medium
  • high - High
    • -

    Properties

    +

    Properties

    Name
    @@ -78230,7 +78782,7 @@

    SolutionPriorityEnum

  • moderate - Moderate
  • hardening - Hardening
    • -

    Properties

    +

    Properties

    Name
    @@ -78284,7 +78836,7 @@

    StateEnum

  • closed - Closed
  • unknown - Unknown
    • -

    Properties

    +

    Properties

    Name
    @@ -78348,7 +78900,7 @@

    Status9fcEnum

  • closed-workaround - Closed (Workaround)
  • closed-risk-acceptance - Closed (Risk acceptance)
    • -

    Properties

    +

    Properties

    Name
    @@ -78440,7 +78992,7 @@

    SubOrganization

    Serializer for suborganization endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -78573,7 +79125,7 @@

    SubOrganizationUser

    Serializer for SubOrganization User endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -78679,7 +79231,7 @@

    SubOrganizationsInList

    Serializer for suborganization endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -78797,7 +79349,7 @@

    SubOrganizationsList

    Serializer for suborganization endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -78856,7 +79408,7 @@

    SubTopic

    "remediation_priority": 0 } -

    Properties

    +

    Properties

    Name
    @@ -78948,7 +79500,7 @@

    Success

    "score": "string" } -

    Properties

    +

    Properties

    Name
    @@ -78986,7 +79538,7 @@

    Ticket

    Serializer for Ticket endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -79072,7 +79624,7 @@

    TicketStatusEnum

  • 5 - Closed
  • 6 - Canceled
    • -

    Properties

    +

    Properties

    Name
    @@ -79154,7 +79706,7 @@

    Topic

    ] } -

    Properties

    +

    Properties

    Name
    @@ -79219,7 +79771,7 @@

    TypeEf5Enum

  • keyword - keyword
  • other - other
    • -

    Properties

    +

    Properties

    Name
    @@ -79293,7 +79845,7 @@

    UpdateAutoTagPolicy

    "updated_at": "2019-08-24T14:15:22Z" } -

    Properties

    +

    Properties

    Name
    @@ -79399,7 +79951,7 @@

    UpdateInsightPolicy

    "already_applied": true } -

    Properties

    +

    Properties

    Name
    @@ -79538,7 +80090,7 @@

    User

    Serializer for User endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -79796,7 +80348,7 @@

    UserLite

    "email": "user@example.com" } -

    Properties

    +

    Properties

    Name
    @@ -79839,7 +80391,7 @@

    Vulnerability

    "asset_type": "string", "severity": 0, "cvss_vector": "string", - "cvss_score": "string", + "cvss_score": 10, "status": "new", "title": "string", "description": "string", @@ -79902,7 +80454,7 @@

    Vulnerability

    Serializer for Vulnerability endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -79984,9 +80536,9 @@

    Properties

    - - - + + + @@ -80299,7 +80851,7 @@

    VulnerabilityLite

    Lite Serializer for Vulnerability endpoint.

    -

    Properties

    +

    Properties

    Name
    cvss_scorestringtrueread-onlynumber(double)falsenone none
    @@ -80490,7 +81042,7 @@

    VulnerabilityUser

    "email": "user@example.com" } -

    Properties

    +

    Properties

    Name
    @@ -80541,7 +81093,7 @@

    WebPortLite

    Lite serializer for Port endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -80650,7 +81202,7 @@

    WebServer

    Serializer for WebServer endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -80803,7 +81355,7 @@

    WebServerLite

    Lite Serializer for WebServer endpoint.

    -

    Properties

    +

    Properties

    Name
    @@ -80863,7 +81415,7 @@

    WriteGreyboxRequest

    Serializer for Greybox Request class

    -

    Properties

    +

    Properties

    Name
    @@ -80950,7 +81502,7 @@

    add_owners

    ] } -

    Properties

    +

    Properties

    Name
    @@ -80981,7 +81533,7 @@

    assets_group_add_assets

    ] } -

    Properties

    +

    Properties

    Name
    @@ -81010,7 +81562,7 @@

    assets_group_add_tag

    "value": "string" } -

    Properties

    +

    Properties

    Name
    @@ -81041,7 +81593,7 @@

    bulk_remove_owners

    ] } -

    Properties

    +

    Properties

    Name
    @@ -81075,7 +81627,7 @@

    create_asset

    "exposure": "unknown" } -

    Properties

    +

    Properties

    Name
    @@ -81141,7 +81693,7 @@

    custom_remediations_add_owners

    ] } -

    Properties

    +

    Properties

    Name
    @@ -81172,7 +81724,7 @@

    custom_remediations_add_vu ] } -

    Properties

    +

    Properties

    Name
    @@ -81206,7 +81758,7 @@

    response_assets_group_add_tag

    } } -

    Properties

    +

    Properties

    Name
    @@ -81242,7 +81794,7 @@

    retests_update_comment

    "comment": "string" } -

    Properties

    +

    Properties

    Name
    @@ -81272,7 +81824,7 @@

    upload_file_attachements

    "file": "http://example.com" } -

    Properties

    +

    Properties

    Name
    Name