Get All Systems Deprecating soon

Retrieves all systems managed by Endpoint Central along with their patch health and scan.

This API endpoint is deprecating soon

Endpoints

get /api/1.4/patch/allsystems

Copy full URL

Request URL

https://{server-hostname}:8383/api/1.4/patch/allsystems

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/1.4/patch/allsystems \
  --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/api/1.4/patch/allsystems"))
        .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", "/api/1.4/patch/allsystems", 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/api/1.4/patch/allsystems"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/patch/allsystems' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

LinksJSON object

Pagination links for next and previous pages

Show Sub-Attributes

nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

messageResponseJSON array

Array of system entries

Show Sub-Attributes

JSON object

Show Sub-Attributes

agent_last_bootup_timestring

Last boot time in epoch milliseconds

agent_last_bootup_time_transformstring

Formatted last boot time

agent_last_contact_timestring

Last contact time in epoch milliseconds

agent_last_contact_time_transformstring

Formatted last contact time

agent_last_ds_contact_timestring

Last DS contact time in epoch, or -1

agent_last_ds_contact_time_transformstring

Formatted last DS contact time, or --

agent_logged_on_usersstring

Currently logged on users

agent_logged_on_users_transformstring

Transformed logged on users

branch_office_idstring

Branch office identifier

branch_office_namestring

Branch office name

branch_office_name_transformstring

Transformed branch office name

branchmemberresourcerel_resource_idstring

Branch member resource relation ID

computer_live_statusstring

Computer live status code

computer_status_update_timestring

Status update time in epoch

critical_patch_countstring

Number of critical missing patches

critical_patch_count_transformstring

Transformed critical patch count, or --

customer_idstring

Customer identifier

customer_namestring

Customer name

customerinfo_customer_idstring

Customer info customer ID

deployment_statusstring

Deployment status code

deployment_status_transformstring

Transformed deployment status, or --

descriptionstring

System description, or null

description_transformstring

Transformed description, or --

domain_netbios_namestring

Domain NetBIOS name

domain_netbios_name_transformstring

Transformed domain name

fqdn_namestring

Fully qualified domain name

friendly_namestring

Friendly name of the computer

friendly_name_transformstring

Transformed friendly name

i18nstring

Internationalization/language setting

i18n_transformstring

Transformed language display

important_patch_countstring

Number of important missing patches

important_patch_count_transformstring

Transformed important patch count, or --

installed_bios_patchesstring

Count of installed BIOS patches

installed_bios_patches_transformstring

Transformed installed BIOS patches count

installed_driver_patchesstring

Count of installed driver patches

installed_driver_patches_transformstring

Transformed installed driver patches count

installed_ms_patchesstring

Count of installed Microsoft patches

installed_ms_patches_transformstring

Transformed installed MS patches count

installed_tp_patchesstring

Count of installed third-party patches

installed_tp_patches_transformstring

Transformed installed TP patches count

ip_addressstring

IP address of the system

ip_address_transformstring

Transformed IP address

last_action_initiated_onstring

Last action initiated time, or null

last_operationstring

Last operation performed, or null

last_operation_transformstring

Transformed last operation, or --

last_patched_timestring

Last patched time in epoch, or -1

last_patched_time_transformstring

Formatted last patched time, or --

last_scan_timestring

Last scan time in epoch milliseconds

last_scan_time_transformstring

Formatted last scan time

last_successful_scanstring

Last successful scan time in epoch

last_successful_scan_transformstring

Formatted last successful scan, or --

last_sync_timestring

Last sync time, or null

locationstring

Location, or null

location_transformstring

Transformed location, or --

low_patch_countstring

Number of low-severity missing patches

low_patch_count_transformstring

Transformed low patch count, or --

mac_addressstring

MAC address

mac_address_transformstring

Transformed MAC address

missing_bios_patchesstring

Count of missing BIOS patches

missing_bios_patches_transformstring

Transformed missing BIOS patches count

missing_driver_patchesstring

Count of missing driver patches

missing_driver_patches_transformstring

Transformed missing driver patches count

missing_ms_patchesstring

Count of missing Microsoft patches

missing_ms_patches_transformstring

Transformed missing MS patches count

missing_tp_patchesstring

Count of missing third-party patches

missing_tp_patches_transformstring

Transformed missing TP patches count

moderate_patch_countstring

Number of moderate-severity missing patches

moderate_patch_count_transformstring

Transformed moderate patch count, or --

os_languagestring

OS language code

os_language_abbrstring

OS language abbreviation

os_namestring

Operating system name

os_name_transformstring

Transformed OS name

os_platformstring

OS platform code: 1=Windows, 2=Mac, 3=Linux

os_platform_namestring

OS platform display name

os_platform_name_transformstring

Transformed platform name

osflavor_idstring

OS flavor identifier

oslanguage_languageidstring

OS language identifier

ownerstring

System owner, or null

owner_email_idstring

Owner email, or null

owner_email_id_transformstring

Transformed owner email, or --

owner_transformstring

Transformed owner, or --

patchmgmtosinfo_resource_idstring

Patch mgmt OS info resource ID

pmreshealthstatus_resource_idstring

PM resource health status resource ID

pmresourcepatchcount_resource_idstring

PM resource patch count resource ID

processor_architecturestring

Processor architecture code

reboot_req_statusstring

Reboot required status, or null

remarksstring

Remarks, or null

resource_health_statusstring

Resource health status code

resource_health_status_transformstring

Transformed health status display

resource_idstring

Resource identifier

resource_namestring

Resource name

resource_name_transformstring

Transformed resource name

resource_resource_idstring

Resource-resource ID

resourcedeploymentstatus_resource_idstring

Deployment status resource ID

resourcetorebootdetails_resource_idstring

Reboot details resource ID, or null

scan_remarksstring

Scan remarks message key

scan_statusstring

Scan status code

search_tagstring

Search tag, or null

search_tag_transformstring

Transformed search tag, or --

service_packstring

Service pack or OS version

service_pack_transformstring

Transformed service pack

shutdown_statusstring

Shutdown status, or null

shutdown_status_update_timestring

Shutdown status update time, or null

status_imagestring

Status image path

status_labelstring

Status label

timezone_offsetstring

Timezone offset in minutes

timezone_offset_transformstring

Formatted timezone offset

total_bios_patchesstring

Total BIOS patches count

total_bios_patches_transformstring

Transformed total BIOS patches

total_driver_patchesstring

Total driver patches count

total_driver_patches_transformstring

Transformed total driver patches

total_ms_patchesstring

Total Microsoft patches count

total_ms_patches_transformstring

Transformed total MS patches

total_patches_columnstring

Total patches column value

total_patches_column_transformstring

Transformed total patches, or --

total_tp_patchesstring

Total third-party patches count

total_tp_patches_transformstring

Transformed total TP patches

metadataJSON object

Pagination metadata

Show Sub-Attributes

limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Paginated list of managed systems

Copied!

  {
    "response_code": 200,
    "message_type": "allsystems",
    "message_response": {
      "allsystems": [
        {
          "branch_office_name": "Local Office",
          "scan_status": 228,
          "resource_health_status": 3,
          "agent_last_contact_time": 1553069591000,
          "critical_patch_count": 2,
          "domain_netbios_name": "DOMAIN",
          "ip_address": "192.168.1.100",
          "os_platform_name": "Windows",
          "installed_tp_patches": 9,
          "installed_ms_patches": 12,
          "important_patch_count": 2,
          "service_pack": "Windows 10 Version 1809 (x64)",
          "missing_ms_patches": 2,
          "resource_id": 301,
          "os_name": "Windows 10 Professional Edition (x64)",
          "missing_tp_patches": 3,
          "computer_live_status": 1,
          "resource_name": "COMPUTER-01",
          "last_scan_time": 1553073465582,
          "last_successful_scan": 1553073465582
        }
      ],
      "total": 97,
      "limit": 25,
      "page": 1
    },
    "message_version": "1.0",
    "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.