Attach one or more deployment targets to a deployment task.

Adds machines (by serial number, MAC address, IP, and subnet) as targets of the deployment task.

Endpoints

put /emsapi/osdeployer/tasks/{taskId}/targets

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.OSDTask.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/deploymentTaskTargetDetails.v1+jsonCopied!

AcceptstringMandatory

application/deploymentTaskTargetAddedStatus.v1+jsonCopied!

- Path Parameters

taskIdstringMandatory

ID of the OS Deployment task

- Request Body

application/deploymentTaskTargetDetails.v1+json

JSON Array

A single deployment target.

Hide Sub-Attributes

JSON Object

Show Sub-Attributes

serialOrMACstringMandatory

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

ipAddressstringOptional

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

subnetMaskstringOptional

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

targetDescriptionstringOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomains/emsapi/osdeployer/tasks/{taskId}/targets \
  --header 'Accept: application/deploymentTaskTargetAddedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentTaskTargetDetails.v1+json' \
  --data '[{"serialOrMAC":"AA:BB:CC:11:22:33"},{"serialOrMAC":"AA:BB:CC:11:22:34"}]'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/emsapi/osdeployer/tasks/{taskId}/targets"))
        .header("Content-Type", "application/deploymentTaskTargetDetails.v1+json")
        .header("Accept", "application/deploymentTaskTargetAddedStatus.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("[{\"serialOrMAC\":\"AA:BB:CC:11:22:33\"},{\"serialOrMAC\":\"AA:BB:CC:11:22:34\"}]"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "[{\"serialOrMAC\":\"AA:BB:CC:11:22:33\"},{\"serialOrMAC\":\"AA:BB:CC:11:22:34\"}]"

headers = {
    'Content-Type': "application/deploymentTaskTargetDetails.v1+json",
    'Accept': "application/deploymentTaskTargetAddedStatus.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/emsapi/osdeployer/tasks/{taskId}/targets", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/deploymentTaskTargetDetails.v1+json");
    headersMap.put("Accept", "application/deploymentTaskTargetAddedStatus.v1+json");

    data=List();
    data_item1=Map();
    data_item1.put("serialOrMAC","value");
    data.add(data_item1);

    response = invokeUrl
    [
        url: "https://appDomains/emsapi/osdeployer/tasks/{taskId}/targets"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/deploymentTaskTargetDetails.v1+json")
$headers.Add("Accept", "application/deploymentTaskTargetAddedStatus.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/emsapi/osdeployer/tasks/{taskId}/targets' -Method PUT -Headers $headers -ContentType 'application/deploymentTaskTargetDetails.v1+json' -Body '[{"serialOrMAC":"AA:BB:CC:11:22:33"},{"serialOrMAC":"AA:BB:CC:11:22:34"}]'

Sample Request Body

Attach two targets to a task

Copied!

  [
    {
      "targetDescription": "Sales floor row 1",
      "serialOrMAC": "AA:BB:CC:11:22:33",
      "ipAddress": "10.0.10.21",
      "subnetMask": "255.255.255.0"
    },
    {
      "targetDescription": "Sales floor row 2",
      "serialOrMAC": "AA:BB:CC:11:22:34",
      "ipAddress": "10.0.10.22",
      "subnetMask": "255.255.255.0"
    }
  ]

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskTargetAddedStatus.v1+json

JSON Object

Hide Sub-Attributes

isTargetAddedboolean

True if targets were successfully added.

addedTargetsCountinteger

Number of targets successfully added.

failedTargetsCountinteger

Number of targets that could not be added.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Three targets added successfully

Copied!

  {
    "failedTargetsCount": 0,
    "isTargetAdded": true,
    "addedTargetsCount": 3
  }

▼ 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.