Returns the current execution stage, percentage progress, and any error details for a running or finished deployment.
https://{serverurl}/emsapi/osdeployer/deployments/{deploymentId}/status
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
ID of the OS Deployer Deployment
curl --request GET \
--url https://appdomains/emsapi/osdeployer/deployments/{deploymentId}/status \
--header 'Accept: application/deploymentStatus.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Current status of the deployment (e.g., 1 = success, 0 = failed, 2 = in progress).
Human-readable description of the current or final deployment status.
Total time elapsed since the deployment started (e.g., 2 Mins 50 Secs).
Timestamp when the deployment started (e.g., Apr 9, 2024 07:59 AM).
Timestamp when the deployment finished.
ID of the remote office where this deployment ran. Present only for remote office deployments.
True if the computer name was successfully set on the machine after deployment.
Link to a knowledge base article for troubleshooting. Present only when the deployment failed with an error code.
True if the deployment failed due to a credential authentication error. Present only on failure.
True if the deployment failed due to a network connectivity error. Present only on failure.
True if the deployment failed due to a disk error on the target machine. Present only on failure.
Details of the OS image replicated at the remote office. Present only for remote office deployments.
ID of the OS image that was deployed.
Name of the OS image.
Network path (UNC) to the image file on the repository.
Name of the operating system in the image.
True if the image is an offline image (WIM/ESD format).
True if the image file is currently accessible on the repository.
ID of the image repository where the image is stored.
Name of the image repository.
Network path to the image repository.
Total size of the image file in bytes.
Username of the person who created the image.
ID of the remote office that hosts this image.
Name of the remote office that hosts this image.
Hardware and OS details of the source machine from which the image was captured.
Resource ID of the source machine.
Computer name of the source machine.
IP address of the source machine.
Fully qualified domain name of the source machine. Empty if not domain-joined.
OS installed on the source machine at the time the image was captured.
ID of the domain the source machine was joined to.
Domain or workgroup name of the source machine.
MAC address of the source machine.
Service tag or serial number of the source machine.
Hardware model of the source machine.
Hardware manufacturer of the source machine.
Total disk size of the source machine.
Partition style of the source machine's disk (GPT or MBR).
Disk sector size (e.g., 512 Bytes).
Drive type (e.g., SSD or HDD).
BIOS mode of the source machine.
RAM size in a human-readable format.
RAM size in bytes.
CPU model of the source machine.
Whether Secure Boot was enabled on the source machine.
CPU architecture of the source machine (e.g., 64 bit).
True if the OS captured is a Windows 11 variant.
List of remote offices this image has been replicated to. Empty if not replicated.
Percentage of agent/component installation completed on the target machine. Present only for zero-touch deployments.
Percentage of the media booting phase completed. Present only for zero-touch deployments.
Combined transfer progress across all partitions being deployed.
Overall deployment completion percentage (0—100).
Total amount of data transferred so far (in bytes).
Total amount of data to be transferred (in bytes).
Estimated time remaining to complete the deployment.
Current data transfer speed (e.g., 133 MB/sec).
Transfer progress broken down per partition.
ID of the partition (matches a partition from diskInfo.partitions).
Percentage of this partition's data that has been transferred.
Amount of data transferred for this partition (in bytes).
Total size of this partition to be transferred (in bytes).
Estimated time remaining for this partition.
Transfer speed for this partition.
Tracks the results of all actions taken after the OS image was applied.
High-level summary for each post-deployment category (USMT, user addition, user deletion, drivers, applications).
Overall result of user profile migration (USMT).
Outcome: 1 = success, negative value = not configured or skipped.
Human-readable message describing the result or reason for skipping.
Overall result of adding user accounts to the machine.
Outcome: 1 = success, negative value = not configured or skipped.
Human-readable message describing the result or reason for skipping.
Overall result of removing existing user accounts.
Outcome: 1 = success, negative value = not configured or skipped.
Human-readable message describing the result or reason for skipping.
Overall result of driver installation.
Outcome: 1 = success, negative value = not configured or skipped.
Human-readable message describing the result or reason for skipping.
Overall result of application installation.
Outcome: 1 = success, negative value = not configured or skipped.
Human-readable message describing the result or reason for skipping.
Details of drivers installed during post-deployment.
List of device IDs (as strings) for which drivers were installed. Empty if no drivers were installed.
Phase 0: disk adjustment and initial post-deployment actions before the OS boots.
Overall completion status for this phase: 1 = completed.
Number of tasks in this phase.
Named task results within this phase. Keys vary by phase (e.g., diskAdjustmentStatus, computerNameStatus, domainStatus, localUserAdditionStatus).
Result of disk size adjustment. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of disk partition style conversion (MBR ↔ GPT). Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of recovery partition setup. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of driver installation. Present in groupZeroStatus, groupOneStatus, and groupTwoStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of the configured post-deployment machine action (e.g., shutdown/restart). Present in groupZeroStatus and groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of computer name assignment. Present in groupOneStatus.
Outcome: 1 = completed successfully.
Human-readable result message.
Time taken (e.g., 15 Secs).
KB article URL for troubleshooting. Empty on success.
The computer name that was actually assigned to the machine.
Result of placing the machine in the configured Organisational Unit. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of domain join. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of adding local user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Result of adding domain user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Phase 1: computer naming, domain join, and user account creation after the OS boots.
Overall completion status for this phase: 1 = completed.
Number of tasks in this phase.
Named task results within this phase. Keys vary by phase (e.g., diskAdjustmentStatus, computerNameStatus, domainStatus, localUserAdditionStatus).
Result of disk size adjustment. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of disk partition style conversion (MBR ↔ GPT). Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of recovery partition setup. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of driver installation. Present in groupZeroStatus, groupOneStatus, and groupTwoStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of the configured post-deployment machine action (e.g., shutdown/restart). Present in groupZeroStatus and groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of computer name assignment. Present in groupOneStatus.
Outcome: 1 = completed successfully.
Human-readable result message.
Time taken (e.g., 15 Secs).
KB article URL for troubleshooting. Empty on success.
The computer name that was actually assigned to the machine.
Result of placing the machine in the configured Organisational Unit. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of domain join. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of adding local user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Result of adding domain user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Phase 2: user profile restoration.
Overall completion status for this phase: 1 = completed.
Number of tasks in this phase.
Named task results within this phase. Keys vary by phase (e.g., diskAdjustmentStatus, computerNameStatus, domainStatus, localUserAdditionStatus).
Result of disk size adjustment. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of disk partition style conversion (MBR ↔ GPT). Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of recovery partition setup. Present in groupZeroStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of driver installation. Present in groupZeroStatus, groupOneStatus, and groupTwoStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of the configured post-deployment machine action (e.g., shutdown/restart). Present in groupZeroStatus and groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of computer name assignment. Present in groupOneStatus.
Outcome: 1 = completed successfully.
Human-readable result message.
Time taken (e.g., 15 Secs).
KB article URL for troubleshooting. Empty on success.
The computer name that was actually assigned to the machine.
Result of placing the machine in the configured Organisational Unit. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of domain join. Present in groupOneStatus.
Outcome: 1 = completed successfully; negative value = skipped or not configured.
Human-readable message describing the result.
Time taken to complete this action (e.g., 32 Secs, 1 Min 1 Secs). '--' if not applicable.
Link to a knowledge base article for troubleshooting errors. Empty string if the action succeeded.
Result of adding local user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Result of adding domain user accounts. Present in groupOneStatus.
Outcome: 1 = all users added successfully.
Human-readable result message.
Total time taken to add all users.
Per-user addition results. One entry per user account processed.
ID of the user account that was processed.
Outcome for this user: 1 = added successfully.
Human-readable result for this user.
Time taken to add this user.
KB article URL for troubleshooting. Empty on success.
Deployment currently applying the image
{
"deploymentDuration": "2 Mins 50 Secs",
"deploymentStatus": 2,
"deploymentRemarks": "Deployment in progress",
"overallProgress": {
"estimatedTime": "3 Mins",
"completedSize": "5368709120",
"totalSize": "11444242432",
"completedPercent": 47,
"speed": "133 MB/sec"
},
"deploymentStartTime": "Apr 9, 2024 07:59 AM",
"isComputerNameAssigned": false
}
Deployment failed due to a credential error
{
"deploymentDuration": "5 Mins 12 Secs",
"deploymentStatus": 0,
"isNetworkError": false,
"deploymentRemarks": "Domain join failed: credentials rejected",
"deploymentReadKBurl": "https://support.example.com/kb/OSD-1042",
"deploymentStartTime": "Apr 9, 2024 07:59 AM",
"isComputerNameAssigned": false,
"isCredentialError": true,
"isTargetDiskError": false,
"deploymentCompletedTime": "Apr 9, 2024 08:04 AM"
}
Deployment completed with post-deployment actions (domain join, user addition, driver install)
{
"deploymentDuration": "2 Mins 10 Secs",
"deploymentStatus": 7,
"deploymentRemarks": "Post Deployment completed successfully",
"overallProgress": {
"estimatedTime": "1 Sec",
"completedSize": "8369957888",
"totalSize": "8369957888",
"completedPercent": 100,
"speed": "63 MB/sec"
},
"deploymentStartTime": "Jul 8, 2026 09:18 PM",
"postDeploymentProgress": {
"groupZeroStatus": {
"groupStatusCount": 4,
"groupStatus": 1,
"groupTaskStatusDetails": {
"driverInstallationStatus": {
"duration": "4 Secs",
"remarks": "Completed",
"status": 1
},
"postDeploymentActionStatus": {
"duration": "--",
"remarks": "Completed",
"status": 1
},
"recoveryDetails": {
"duration": "2 Secs",
"remarks": "Completed",
"status": 1
},
"diskStyleConversionStatus": {
"duration": "7 Secs",
"readKBurl": "",
"remarks": "Success",
"status": 1
},
"diskAdjustmentStatus": {
"duration": "1 Min 1 Secs",
"readKBurl": "",
"remarks": "Completed",
"status": 1
}
}
},
"deploymentDriverDetails": {
"deviceID": [
"902",
"901"
]
},
"groupOneStatus": {
"groupStatusCount": 7,
"groupStatus": 1,
"groupTaskStatusDetails": {
"driverInstallationStatus": {
"duration": "1 Sec",
"remarks": "Completed",
"status": 1
},
"computerNameStatus": {
"duration": "15 Secs",
"readKBurl": "",
"computerName": "CHANGED-at-DEP",
"remarks": "Completed",
"status": 1
},
"ouStatus": {
"duration": "--",
"readKBurl": "",
"remarks": "Completed",
"status": 1
},
"postDeploymentActionStatus": {
"duration": "2 Mins 1 Secs",
"remarks": "Completed",
"status": 1
},
"domainStatus": {
"duration": "8 Mins 53 Secs",
"readKBurl": "",
"remarks": "Completed",
"status": 1
},
"localUserAdditionStatus": {
"duration": "1 Sec",
"userDetailsList": [
{
"duration": "1 Sec",
"readKBurl": "",
"userID": "901",
"remarks": "Completed",
"status": 1
}
],
"remarks": "Success",
"status": 1
},
"domainUserAdditionStatus": {
"duration": "1 Sec",
"userDetailsList": [
{
"duration": "1 Sec",
"readKBurl": "",
"userID": "602",
"remarks": "Completed",
"status": 1
}
],
"remarks": "Success",
"status": 1
}
}
},
"groupTwoStatus": {
"groupStatusCount": 1,
"groupStatus": 1,
"groupTaskStatusDetails": {
"driverInstallationStatus": {
"duration": "1 Sec",
"remarks": "Completed",
"status": 1
}
}
},
"overallStatus": {
"overallUserDeletionStatus": {
"remarks": "Users not configured",
"status": -4
},
"overallDriverStatus": {
"remarks": "Installation completed",
"status": 1
},
"overallUsmtStatus": {
"remarks": "User profiles not configured",
"status": -4
},
"overallUserAdditionStatus": {
"remarks": "Completed",
"status": 1
},
"overallApplicationStatus": {
"remarks": "Applications not configured",
"status": -4
}
}
},
"remoteOfficeID": "1",
"isComputerNameAssigned": true,
"deploymentCompletedTime": "Jul 8, 2026 09:20 PM",
"partitionsProgress": [
{
"estimatedTime": "1 Sec",
"completedSize": "104857088",
"totalSize": "104857088",
"partitionID": "3901",
"completedPercent": 100,
"speed": "63 MB/sec"
},
{
"estimatedTime": "1 Sec",
"completedSize": "7715647488",
"totalSize": "7715647488",
"partitionID": "3902",
"completedPercent": 100,
"speed": "63 MB/sec"
},
{
"estimatedTime": "1 Sec",
"completedSize": "549453312",
"totalSize": "549453312",
"partitionID": "3903",
"completedPercent": 100,
"speed": "63 MB/sec"
}
]
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.