Returns the deployment task's template, schedule, broadcast settings, remote offices, media, and resource IDs.
get /emsapi/osdeployer/tasks/{taskId}
https://{serverurl}/emsapi/osdeployer/tasks/{taskId}
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
ID of the OS Deployment task
curl --request GET \
--url https://appdomains/emsapi/osdeployer/tasks/{taskId} \
--header 'Accept: application/deploymentTaskDetails.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Name of the deployment task.
Optional description of the task.
ID of the OS deployment template associated with this task.
Indicates how target machines are identified (e.g., by MAC address or zero-touch).
True if the task is configured to run on a schedule.
True if the task is set to remain active continuously.
Username of the person who created the task.
Authentication code configured for the task, if any.
List of target machines added to this task.
Machine identifier — serial number or MAC address. Required; omitting returns SERIAL_OR_MAC_INVALID.
IPv4 address of the target machine, dotted-quad format. If provided, subnetMask is also required.
IPv4 subnet mask, dotted-quad format. Required when ipAddress is provided.
Free-form description of the target (e.g., physical location).
Broadcast and schedule configuration for the task.
Broadcast mode: 0 = Unicast, 1 = Multicast.
Maximum bandwidth per target in kbps.
Time in minutes to wait for clients to join before starting transmission.
Schedule for the task start.
Schedule type (e.g., NONE, DAILY, WEEKLY, MONTHLY).
Epoch-millis timestamp at which the task is scheduled to start.
Display name of the schedule.
Epoch-millis timestamp of the next scheduled run. Absent if the task has no future runs.
Current status of the task as a text code (e.g., TASK_COMPLETED, TASK_RUNNING, TASK_STOPPED).
True if the task has been committed (via PUT /tasks/{taskId}); false if still in draft state.
True if Wake-on-LAN is enabled for this task.
Additional information about the current task status.
IDs of all deployments initiated by this task.
A default deployment task response
{
"taskCreatedBy": "admin",
"authCode": "9p5z",
"imageID": "1",
"taskDescription": "",
"targetType": "1",
"isScheduled": false,
"templateID": "1",
"taskSettings": {
"bandwidth": "65000000",
"waitTime": "10",
"broadcastType": "2"
},
"isAlwaysActive": false,
"taskName": "DeploymentTask11",
"remarks": "Task ended as server had stopped during deployment",
"deploymentIDs": [],
"status": 6
}
![]()
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.