Get current targets as resource IDs

Returns the current targets of a collection, configuration as an array of numeric resource IDs.The response format matches the input expected by the modifyTargets endpoint — making it easy to fetch, modify, and resubmit targets without format conversion.To use this format, pass useResourceIdFormat=true as a query parameter.

Endpoints

get /dcapi/target/{collectionId}/getTargets

Copy full URL

Request URL

https://{serverurl}/dcapi/target/{collectionId}/getTargets

Scope

DesktopCentralCloud.Configurations.READ, DesktopCentralCloud.SWDeployment.READ, DesktopCentralCloud.PatchMgmt.READ, DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/getTargets.v1+jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique numeric identifier of the collection whose targets are to be retrieved. Fetch from Get Configurations View .

- Query Parameters

useResourceIdFormatbooleanMandatory

Set to true to receive the Resource-ID format response containing numeric resource IDs. Omit or set false for the domain/value pairs format.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomains/dcapi/target/{collectionId}/getTargets?useResourceIdFormat=SOME_BOOLEAN_VALUE' \
  --header 'Accept: application/getTargets.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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/dcapi/target/{collectionId}/getTargets?useResourceIdFormat=SOME_BOOLEAN_VALUE"))
        .header("Accept", "application/getTargets.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/dcapi/target/{collectionId}/getTargets?useResourceIdFormat=SOME_BOOLEAN_VALUE", headers=headers)

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

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


    parameters = "useResourceIdFormat=value";

    headersMap = Map();
    headersMap.put("Accept", "application/getTargets.v1+json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/target/{collectionId}/getTargets" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/getTargets.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/target/{collectionId}/getTargets?useResourceIdFormat=SOME_BOOLEAN_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

collectionIdlong

Unique collection ID whose targets are returned.

targetDetailsJSON Object

Target descriptor in Resource ID format containing the target type and an array of numeric resource IDs.

Show Sub-Attributes

typestring

Target category — 'computer' for computer-based collections, 'user' for user-based collections.

valuesarray

Array of numeric resource IDs currently targeted by the collection. Only actively managed resources (MANAGED_BY_DC) are included for computer-type collections.

- HTTP code 400

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

CONFIG_INVALID_INPUT_DATA: the specified collection is expired or no longer alive.

error_descriptionstring

Message indicating the collection is not active or has expired.

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

Possible Response Codes

200HTTP code

400HTTP code

401HTTP code

Sample Response: HTTP 200

Computer-type collection with three targeted resources (Resource ID format)

Copied!

  {
    "collectionId": 12345,
    "targetDetails": {
      "values": [
        1001,
        1002,
        1003
      ],
      "type": "computer"
    }
  }

▼ Show full

User-type collection with two targeted user resources (Resource ID format)

Copied!

  {
    "collectionId": 67890,
    "targetDetails": {
      "values": [
        2001,
        2002
      ],
      "type": "user"
    }
  }

▼ Show full

Sample Response: HTTP 400

Collection is expired or no longer active

Copied!

  {
    "error_description": "Collection is not active or expired",
    "error_code": "CONFIG_INVALID_INPUT_DATA"
  }

▼ Show full

Sample Response: HTTP 401

User lacks read role for this configuration type

Copied!

  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | 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.