Retrieves a list of all system misconfigurations detected in the network

This API lists system misconfigurations across the network, with filters for name, description, severity, post-deployment issues, and ID to enable precise data retrieval

Endpoints

get /dcapi/threats/systemmisconfigurations

Copy full URL

Request URL

https://{serverurl}/dcapi/threats/systemmisconfigurations

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pagestringOptional

Displays the content of the provided page number.

customernamestringOptional

customeridlongOptional

pageLimitstringOptional

Displays the provided number of misconfigurations details per page.

severitystringOptional

Filters misconfigurations based on the severity provided.

os_platformstringOptional

Filters misconfigurations based on the platform provided.

fix_availabilitystringOptional

Filters misconfigurations based on the fix availability provided.

descriptionstringOptional

Filters misconfigurations that contain the provided misconfiguration description.

affected_systemsstringOptional

misconfig_namestringOptional

Filters misconfigurations that contain the provided misconfiguration name.

solutionstringOptional

Filters misconfigurations based on the solution provided.

reboot_requiredstringOptional

Filters misconfigurations based on the reboot option provided.

post_deployment_issuesstringOptional

Filters misconfigurations that contain the provided post deployment issues.

undo_supportedbooleanOptional

Filters misconfigurations based on the reversibility support provided.

categorystringOptional

Filters misconfigurations based on the category provided.

misconfigidstringOptional

Filters misconfigurations based on the misconfiguration ID provided.

potential_impactbooleanOptional

Filters misconfigurations based on the potential impact provided.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/dcapi/threats/systemmisconfigurations \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/threats/systemmisconfigurations"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/dcapi/threats/systemmisconfigurations", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/threats/systemmisconfigurations"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/threats/systemmisconfigurations' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!

  {
    "metadata": {
      "pageLimit": 30,
      "totalRecords": "2",
      "totalPages": 1,
      "links": {
        "next": null,
        "prev": null
      },
      "page": 1
    },
    "response_code": 200,
    "message_type": "systemmisconfigurations",
    "message_response": {
      "systemmisconfigurations": [
        {
          "severity": "Critical",
          "os_platform": "Windows",
          "fix_availability": "not available",
          "description": "A host-based firewall lets a user define a set of rules that controls incoming and outgoing network traffic across a particular device. This prevents unauthorized access and unrestricted connections to the device. Windows-based computers comes with an in-built firewall. Resolve this misconfiguration to enable Microsoft windows firewall in your windows-based computers.",
          "affected_systems": 1,
          "misconfig_name": "Windows firewall disabled/ No third-party firewall present",
          "solution": "no fix available",
          "reboot_required": "not required",
          "post_deployment_issues": "No Impact",
          "undo_supported": false,
          "category": "Windows Firewall",
          "misconfigid": "4",
          "potential_impact": false
        },
        {
          "severity": "Critical",
          "os_platform": "Windows",
          "fix_availability": "not available",
          "description": "BitLocker is a full disk encryption feature included in Microsoft Windows versions starting with Windows Vista. It is designed to protect data by providing encryption for entire volumes. In many cases, encryption of customer data is required by law. Resolution: It is advisable to enable bitlocker encryption to protect entire disk volumes.",
          "affected_systems": 1,
          "misconfig_name": "Bitlocker not enabled",
          "solution": "no fix available",
          "reboot_required": "not required",
          "post_deployment_issues": "No Impact",
          "undo_supported": false,
          "category": "BitLocker Encryption",
          "misconfigid": "6",
          "potential_impact": false
        }
      ]
    },
    "status": "success"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.