Fetch full configuration of a deployment task

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

Returns the deployment task's template, schedule, broadcast settings, remote offices, media, and resource IDs.

Request URL

https://{serverurl}/emsapi/osdeployer/tasks/{taskId}

Scope

DesktopCentralCloud.OSDTask.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

taskIdstringMandatory

ID of the OS Deployment task

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/emsapi/osdeployer/tasks/{taskId} \
  --header 'Accept: application/deploymentTaskDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskDetails.v1+json
JSON Object
Hide Sub-Attributes
taskNamestring

Name of the deployment task.

taskDescriptionstring

Optional description of the task.

templateIDlong

ID of the OS deployment template associated with this task.

targetTypeinteger

Indicates how target machines are identified (e.g., by MAC address or zero-touch).

isScheduledboolean

True if the task is configured to run on a schedule.

isAlwaysActiveboolean

True if the task is set to remain active continuously.

taskCreatedBystring

Username of the person who created the task.

authCodestring

Authentication code configured for the task, if any.

taskTargetsJSON Array

List of target machines added to this task.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
serialOrMACstring

Machine identifier — serial number or MAC address. Required; omitting returns SERIAL_OR_MAC_INVALID.

ipAddressstring

IPv4 address of the target machine, dotted-quad format. If provided, subnetMask is also required.

subnetMaskstring

IPv4 subnet mask, dotted-quad format. Required when ipAddress is provided.

targetDescriptionstring

Free-form description of the target (e.g., physical location).

taskSettingsJSON Object

Broadcast and schedule configuration for the task.

Show Sub-Attributes
broadcastTypeinteger

Broadcast mode: 0 = Unicast, 1 = Multicast.

bandwidthlong

Maximum bandwidth per target in kbps.

waitTimelong

Time in minutes to wait for clients to join before starting transmission.

scheduleDetailsJSON Object

Schedule for the task start.

Show Sub-Attributes
scheduleTypestring

Schedule type (e.g., NONE, DAILY, WEEKLY, MONTHLY).

scheduledTimelong

Epoch-millis timestamp at which the task is scheduled to start.

scheduleNamestring

Display name of the schedule.

nextRunTimelong

Epoch-millis timestamp of the next scheduled run. Absent if the task has no future runs.

statusstring

Current status of the task as a text code (e.g., TASK_COMPLETED, TASK_RUNNING, TASK_STOPPED).

isTaskCommittedboolean

True if the task has been committed (via PUT /tasks/{taskId}); false if still in draft state.

wakeOnLanboolean

True if Wake-on-LAN is enabled for this task.

remarksstring

Additional information about the current task status.

deploymentIDsarray

IDs of all deployments initiated by this task.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

A default deployment task response

Copied!
  {
    "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
  }
                
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.