Retrieve Reboot Pending Systems

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves systems that are pending reboot after patch installation.

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/rebootPendingSystems.v1+jsonapplication/rebootPendingSystems.v1+jsonCopied!

- Query Parameters

pageLimitintegerOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

searchColumnstringOptional

Name of the column in which the search value needs to be looked up. Use together with searchValue.

searchValuestringOptional

Text to look up in the column given in searchColumn. Use together with searchColumn.

platformstringOptional

Returns only the systems or patches belonging to the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux. Multiple values can be given as a comma-separated list.

domainstringOptional

Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from Get Domains api

customGroupstringOptional

Returns only the systems that are members of the given custom group. Provide the custom group name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the custom group names from Get Custom Groups api

branchOfficestringOptional

Returns only the systems that belong to the given remote office (branch office). Provide the remote office name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the remote office names from Get Remote Offices api

operatingSystemstringOptional

Returns only the systems running the given operating system. Provide the operating system name, for example, Windows 11. Multiple values can be given as a comma-separated list.

mobileViewstringOptional

Set to True to get a compact response meant for the mobile app, which also contains the identifiers needed to perform follow-up actions. Leave empty for the default response.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/rebootPendingSystems \
  --header 'Accept: application/rebootPendingSystems.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
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 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- 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

Sample Response: HTTP 200

Reboot pending systems

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

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_code": "INTERNAL_ERROR",
    "error_description": "dc.rest.api_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.