Retrieve Reboot Pending Systems

Retrieves systems that are pending reboot after patch installation.

Endpoints

get /dcapi/patch/reports/rebootPendingSystems

Copy full URL

Request URL

https://{serverurl}/dcapi/patch/reports/rebootPendingSystems

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageLimitintegerOptional

Number of records per page (default 25)

pageintegerOptional

Page number to retrieve (1-based)

searchColumnstringOptional

Column name to search within

searchValuestringOptional

Value to search for in the specified column

platformstringOptional

1: Windows, 2: Mac, 3: Linux (comma-separated)

domainstringOptional

Domain name filter

customGroupstringOptional

Custom group name filter

branchOfficestringOptional

Branch office name filter

operatingSystemstringOptional

Operating system name filter

mobileViewstringOptional

Set True for mobile-optimized view

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/dcapi/patch/reports/rebootPendingSystems \
  --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/patch/reports/rebootPendingSystems"))
        .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/patch/reports/rebootPendingSystems", 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/patch/reports/rebootPendingSystems"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

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

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 reboot pending system entries

Show Sub-Attributes

JSON Object

Show Sub-Attributes

AgentTimeZonestring

Time zone of the agent (e.g., GMT-08:00)

AgentVersionstring

Version of the installed agent

ComputerNamestring

Name of the computer

DeploymentPolicystring

Deployment policy applied to the system

DeviceFriendlyNamestring

Friendly display name of the device

Domainstring

Domain name of the computer

Healthstring

System health status: Healthy, Vulnerable, Highly Vulnerable

IpAddressstring

IP address of the system

Languagestring

Language of the operating system

LastBootTimestring

Last boot time of the system

LastContactTimestring

Last time the agent contacted the server

LastContactedTimeWithDsstring

Last contacted time with distribution server, or --

LastPatchedTimestring

Last time a patch was applied, or --

Locationstring

Location of the system, or --

LoggedOnUsersstring

Currently logged on users

MacAddressstring

MAC address of the system

Notesstring

Admin notes, or --

OperatingSystemstring

Full operating system name and architecture

Ownerstring

Owner of the system, or --

OwnerEmailstring

Email of the system owner, or --

RebootPendingDuration(inDays)string

Duration the reboot has been pending

RebootPendingReasonstring

Reason the reboot is pending

RebootRequiredReasonstring

Reason a reboot is required

RemoteOfficestring

Remote office name

SearchTagstring

Search tag, or --

ServicePackstring

Service pack or OS version

TaskNamestring

Name of the deployment task

TaskTypestring

Type of deployment task

UpcomingForceRebootTimestring

Scheduled force reboot time

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

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Reboot pending systems

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "OperatingSystem": "Windows 11 Professional Edition (x64)",
        "Owner": "--",
        "AgentVersion": "10.0.338.W",
        "RebootRequiredReason": "Some patches or software require a system restart to complete installation.",
        "AgentTimeZone": "GMT-08:00",
        "LastPatchedTime": "--",
        "LastContactedTimeWithDs": "--",
        "UpcomingForceRebootTime": "Feb 13, 2026 06:13 PM",
        "RemoteOffice": "Default Remote Office",
        "LastBootTime": "Dec 14, 2015 10:44 AM",
        "RebootPendingReason": "Awaiting user response to reboot prompt",
        "Language": "Multilingual",
        "LastContactTime": "Mar 3, 2025 06:20 PM",
        "TaskType": "Automate Patch Deployment",
        "SearchTag": "--",
        "DeploymentPolicy": "Allow user intervention (Skip deployment/reboot)",
        "Notes": "--",
        "OwnerEmail": "--",
        "DeviceFriendlyName": "WinMachine1",
        "Health": "Highly Vulnerable",
        "MacAddress": "d4:06:b6:a2:34",
        "LoggedOnUsers": "Administrator",
        "TaskName": "MyTask5",
        "ComputerName": "WinMachine1",
        "ServicePack": "Windows 11 Version 23H2 (x64)",
        "IpAddress": "118.40.20.170",
        "RebootPendingDuration(inDays)": "3 Day(s)",
        "Domain": "ZOHOCORP",
        "Location": "--"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!

  {
    "error_description": "dc.rest.api_internal_error",
    "error_code": "INTERNAL_ERROR"
  }

▼ Show full

Duration: 1 minute | Threshold: 50 | 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.