List Patch Status Across Deprecating soon

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

This API provides detailed information about the installation status of a given patch on all applicable computers within the Endpoint Central environment.

This API endpoint is deprecating soon

View new endpoint   >

Request URL

https://{serverurl}/api/1.4/patch/allpatchdetails Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

patchidstringOptional

Unique ID of the patch to filter by. Get the patch ID from Get All Patches api

bulletinidstringOptional

Returns only the patches released under the given bulletin. A bulletin is the vendor advisory a patch is published under, for example MS15-041. Get the bulletin ID from Get All Patches api.

severityfilterintegerOptional

Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical.

patchstatusfilterintegerOptional

Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing.

domainfilterstringOptional

Returns only the systems that belong to the given domain. Provide the domain name. Get the domain names from Get Domains api

platformfilterstringOptional

Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.

branchofficefilterstringOptional

Returns only the systems that belong to the given remote office. Provide the remote office name. Get the remote office names from Get Remote Offices api

customgroupfilterstringOptional

Returns only the systems that are members of the given custom group. Provide the custom group name. Get the custom group names from Get Custom Groups api

searchvaluestringOptional

Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.

searchcolumnstringOptional

Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.

searchtypestringOptional

Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.

sortorderstringOptional

Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.

orderbystringOptional

Name of the column (field) in the response by which the records are sorted. Use together with sortorder.

pagelimitstringOptional

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.

languagefilterintegerOptional

Returns only the patches released for the given language. Provide the language ID as listed in Endpoint Central.

patchtypefilterintegerOptional

Returns only the patches of the given update type. Accepted values: 0 - Security Updates, 1 - Non-Security Updates, 2 - Third Party Updates, 4 - Definition Updates, 5 - Service Packs, 6 - Feature Packs, 7 - Rollups, 8 - Tools, 9 - Drivers, 10 - Optional Updates, 11 - Preview Rollups, 12 - BIOS.

deploymentstatusfilterintegerOptional

Returns only the configurations with the given deployment status. Accepted values: 3 - In Progress, 6 - Succeeded, 10 - In Progress with Failures, 12 - Yet to Deploy, 16 - Failed.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/patch/allpatchdetails \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Value: allpatchdetails

message_responseJSON Object

Paginated patch status per system

Show Sub-Attributes
totalstring

Total number of patch-system records

allpatchdetailsJSON Array

Array of patch detail objects per system

Show Sub-Attributes
JSON Object
Show Sub-Attributes
affected_patch_statusstring

Affected patch status code

agent_last_bootup_timestring

Agent last bootup time in epoch milliseconds

agent_last_contact_timestring

Agent last contact time in epoch milliseconds

agent_last_contact_time_transformstring

Formatted agent last contact time

agent_logged_on_usersstring

Logged on users on the agent

agent_logged_on_users_transformstring

Transformed logged on users

agent_versionstring

Agent version string

agent_version_transformstring

Transformed agent version

branch_office_namestring

Branch office name

branch_office_name_transformstring

Transformed branch office name

bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID

collection_namestring

Collection name, or null

collection_name_transformstring

Transformed collection name

computer_live_statusstring

Computer live status code

computer_status_update_timestring

Computer status update time in epoch milliseconds

config_idstring

Configuration ID, or null

config_id_transformstring

Transformed configuration ID

deploy_remarksstring

Deployment remarks, or null

deploy_remarks_argsstring

Deployment remarks arguments, or null

deploy_remarks_transformstring

Transformed deployment remarks

deployer_first_namestring

Deployer first name, or null

deployer_first_name_transformstring

Transformed deployer name

deployment_statusstring

Deployment status, or null

domain_netbios_namestring

Domain NetBIOS name

domain_netbios_name_transformstring

Transformed domain name

first_namestring

Name of the user who approved the patch

first_name_transformstring

Transformed approving user name

friendly_namestring

Friendly computer name

friendly_name_transformstring

Transformed friendly name

i18nstring

Internationalization language

i18n_transformstring

Transformed i18n value

image_namestring

Image path for approval status

install_error_codestring

Installation error code, or null

installed_timestring

Installation time in epoch milliseconds, or null

installed_time_transformstring

Formatted installation time

ip_addressstring

IP address of the system

ip_address_transformstring

Transformed IP address

labelstring

Approval status label key

label_transformstring

Transformed approval status display

mac_addressstring

MAC address of the system

mac_address_transformstring

Transformed MAC address

managedcomputer_resource_idstring

Managed computer resource ID

os_languagestring

OS language code

os_namestring

Operating system name

os_name_transformstring

Transformed OS name

os_platformstring

OS platform code

patch_affected_status_imagestring

Image path for patch affected status

patch_affected_status_labelstring

Patch affected status label key

patch_affected_status_label_transformstring

Transformed patch affected status

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_idstring

Unique patch identifier

patch_id_transformstring

Transformed patch ID

patch_install_status_imagestring

Image path for install status, or null

patch_install_status_labelstring

Install status label, or null

patch_install_status_label_transformstring

Transformed install status label

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch file name

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_sizestring

Patch file size in bytes

patch_size_transformstring

Formatted patch file size

patch_statusstring

Patch status code

patch_supported_timestring

Patch supported time in epoch milliseconds

patch_supported_time_transformstring

Formatted patch supported date

patch_typestring

Patch type code

patch_uninstall_statusstring

Uninstall support status code

patch_uninstall_status_transformstring

Transformed uninstall status display

patch_updated_timestring

Last updated time in epoch milliseconds

patch_updated_time_transformstring

Formatted last updated date and time

platformstring

Platform code: 1=Windows, 2=Mac, 3=Linux

platform_namestring

Platform display name

pmseverity_namestring

Severity display name

resource_idstring

Resource identifier

resource_namestring

Resource/computer name

resource_name_transformstring

Transformed resource name

resourcemacip_resource_idstring

Resource MAC/IP resource ID

service_packstring

Service pack version

service_pack_transformstring

Transformed service pack

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

sqnumberstring

Software version/sequence number

sqnumber_transformstring

Transformed version number

superceded_bystring

Superceded by patch ID, or NA

superceded_by_transformstring

Transformed superceded by value

update_namestring

Update type name

update_name_transformstring

Transformed update type name

user_idstring

User ID of approver

vendor_namestring

Vendor name

vendor_name_transformstring

Transformed vendor name

limitstring

Records per page

pagestring

Current page number

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

- 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

Sample Response: HTTP 200

Copied!
  {
    "message_type": "allpatchdetails",
    "message_response": {
      "total": 26,
      "allpatchdetails": [
        {
          "branch_office_name": "Local Office",
          "patch_updated_time": 1552563514708,
          "resource.name": "patch-abc-12-1",
          "installstatusdefn.label": "--",
          "sqnumber": "4057116",
          "os_language": 1,
          "install_error_code": "--",
          "bulletin_id": "MS18-JAN9",
          "update_name": "Security Updates",
          "deploy_remarks": "--",
          "patch_released_time": 1515715200000,
          "patch_size": 0,
          "patch_uninstall_status": 0,
          "resource.domain_netbios_name": "DCPATCH",
          "service_pack": "Windows Server 2012 R2 Gold (x64)",
          "approvestatusdefn.image_name": "/images/approved_icon.gif",
          "affectedpatchstatusdefn.image_name": "/images/success.gif",
          "patch_type": 0,
          "resource.resource_id": 50924,
          "first_name": "DC-SYSTEM-USER",
          "pmseverity.name": "Important",
          "patch_status": 211,
          "severity": 3,
          "patch_id": 23956,
          "patch_name": "SQLPreReqHandler_KB4057116_x64.exe",
          "collection.collection_name": "--",
          "patch_description": "Security update for SQL Server 2012 Service Pack 4 x64 (KB4057116)",
          "approvestatusdefn.label": "dc.common.APPROVED",
          "oslanguage.i18n": "dc.patch.patchinfo.English",
          "deployment_status": "--",
          "vendor_name": "Microsoft",
          "superceded_by": "NA",
          "severity_name": "dc.common.IMPORTANT",
          "resourcemacip.resource_id": 50924,
          "ip_address": "192.0.2.10",
          "deployer.first_name": "--",
          "installstatusdefn.image_name": "--",
          "patch_supported_time": 1518615106000,
          "affectedpatchstatusdefn.label": "dc.common.INSTALLED",
          "agent_version": "10.0.267.W",
          "user_id": 2,
          "resource_id": 50924,
          "os_name": "Windows Server 2012 R2 Standard Edition (x64)",
          "deploy_remarks_args": "--",
          "installed_time": "--"
        }
      ],
      "limit": 25,
      "page": 2
    },
    "message_version": "1.0",
    "status": "success",
    "response_code": 200
  }
                
▼ 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

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

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