Retrieves detailed information for all computers

Provides JSON objects containing detailed information for all computers, such as hostname, IP address, OS, status, remote office details, and more.

Endpoints

get /dcapi/som/computersInfo

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/som/computersInfo

Scope

SOM.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/som/computersInfo \
  --header 'Authorization:  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://appdomain/dcapi/som/computersInfo"))
        .header("Authorization", " 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("appdomain")

headers = { 'Authorization': " d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/dcapi/som/computersInfo", headers=headers)

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

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


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

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/som/computersInfo"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/som/computersInfo' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Array

Hide Sub-Attributes

JSON Object

Show Sub-Attributes

managedStatusinteger

Managed status code of the computer

liveStatusUpdatedOnstring

Timestamp indicating when the live status was last updated

ownerEmailIDstring

Email address of the computer owner

installationStatusstring

Current installation status of the agent

descriptionstring

Description of the computer, if provided

computerFullNamestring

Full display name of the computer

agentExecutedOnstring

Timestamp indicating when the agent was last executed

statusUpdatedOnstring

Timestamp indicating when the computer status was last updated

osVersionstring

Version of the operating system installed on the computer

computerNamestring

Hostname of the computer

lastContactTimestring

Timestamp of the last successful communication between the computer and the server

osPlatformstring

Operating system platform (for example, Windows, macOS, Linux)

agentUpgradedOnstring

Timestamp indicating when the agent was last upgraded

liveStatusstring

Current live status of the computer

servicePackstring

Service pack or edition details of the operating system

ipAddressstring

IP address assigned to the computer

installationStatusCodeinteger

Numeric code representing the agent installation status

osNamestring

Name of the operating system installed on the computer

computerFQDNNamestring

Fully Qualified Domain Name (FQDN) of the computer

agentUninstalledOnstring

Timestamp indicating when the agent was uninstalled

searchTagstring

Search tag associated with the computer

computerIdstring

Unique identifier of the computer

macAddressstring

MAC address of the computer's network interface

computerGUIDstring

Globally unique identifier (GUID) of the computer

loggedUsersstring

List of users currently or recently logged in to the computer

distributionServerNamestring

Name of the distribution server managing the computer

domainNamestring

Domain to which the computer belongs

customerIDstring

Unique identifier of the customer associated with the computer

agentVersionstring

Version of the agent installed on the computer

supportedOperationinSDPstring

Operations supported for this computer in ServiceDesk Plus (SDP)

agentInstalledOnstring

Timestamp indicating when the agent was installed

locationstring

Location of the computer, if available

remoteOfficeNamestring

Name of the remote office associated with the computer

remoteOfficeIDstring

Unique identifier of the remote office associated with the computer

remarksstring

Additional remarks or notes associated with the computer

Possible Response Codes

200HTTP code

Request processed successfully

Sample Response: HTTP 200

Copied!

  [
    {
      "managedStatus": 61,
      "liveStatusUpdatedOn": "Feb 8, 2023 04:00 PM",
      "ownerEmailID": "--",
      "installationStatus": "Installed Successfully",
      "description": "--",
      "computerFullName": "JACK",
      "agentExecutedOn": "Feb 8, 2023 02:51 PM",
      "statusUpdatedOn": "Feb 8, 2023 02:51 PM",
      "osVersion": "10.0.19045",
      "computerName": "JACK",
      "lastContactTime": "Feb 8, 2023 02:50 PM",
      "osPlatform": "Windows",
      "agentUpgradedOn": "--",
      "liveStatus": "Live",
      "servicePack": "Windows 10 Version 2009 (x64)",
      "ipAddress": "11.33.3.42",
      "installationStatusCode": 22,
      "osName": "Windows 10 Professional Edition (x64)",
      "computerFQDNName": "JACK.EXAMPLE.MAIL.COM",
      "agentUninstalledOn": "--",
      "searchTag": "--",
      "computerId": "601",
      "macAddress": "00:29:0c:aa:00:01,6d:a2:zb:3a:a8:01",
      "computerGUID": "5mtu0yxygxzjliymy0yti4mti1zgi",
      "loggedUsers": "JACK",
      "distributionServerName": "JACK",
      "domainName": "WORKGROUP",
      "customerID": "1",
      "agentVersion": "10.1.2228.20.W",
      "supportedOperationinSDP": "Asset,Remote_Control,Tools",
      "agentInstalledOn": "Feb 8, 2023 01:21 PM",
      "location": "--",
      "remoteOfficeName": "ro1",
      "remoteOfficeID": "301",
      "remarks": "Agent Installed Successfully"
    },
    {
      "managedStatus": 62,
      "liveStatusUpdatedOn": "Feb 7, 2023 06:58 PM",
      "ownerEmailID": "--",
      "installationStatus": "Uninstalled Successfully",
      "description": "--",
      "computerFullName": "ROSE",
      "agentExecutedOn": "Feb 7, 2023 06:52 PM",
      "statusUpdatedOn": "Feb 7, 2023 06:52 PM",
      "osVersion": "10.0.19044",
      "computerName": "ROSE",
      "lastContactTime": "Feb 7, 2023 05:51 PM",
      "osPlatform": "Windows",
      "agentUpgradedOn": "--",
      "liveStatus": "Unknown",
      "servicePack": "Windows 10 Version 21H2 (x64)",
      "ipAddress": "10.51.241.7",
      "installationStatusCode": 23,
      "osName": "Windows 10 Professional Edition (x64)",
      "computerFQDNName": "ROSE.EXAMPLE.MAIL.COM",
      "agentUninstalledOn": "Feb 7, 2023 06:52 PM",
      "searchTag": "--",
      "computerId": "901",
      "macAddress": "0a:00:27:09:00:17,60:a2:89:a4:72:z7",
      "computerGUID": "3mtnjowu0mmi0mjzjmgi2nmqx",
      "loggedUsers": "ROSE-10549",
      "distributionServerName": "JACK",
      "domainName": "WORKGROUP",
      "customerID": "1",
      "agentVersion": "10.1.2228.20.W",
      "supportedOperationinSDP": "Asset",
      "agentInstalledOn": "Feb 6, 2023 10:25 AM",
      "location": "--",
      "remoteOfficeName": "ro1",
      "remoteOfficeID": "301",
      "remarks": "Agent UnInstalled Successfully"
    }
  ]

▼ 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.