Fetch deployment metadata for a single deployment

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 task, device, template, image, and timestamp details for the specified deployment ID.

Endpoints

Request URL

https://{serverurl}/emsapi/osdeployer/deployments/{deploymentId}

Scope

DesktopCentralCloud.OSDDeployment.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

deploymentIdstringMandatory

ID of the OS Deployer deployment

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/deploymentDetails.v1+json
JSON Object
Hide Sub-Attributes
deploymentTypeinteger

Indicates how the deployment was triggered (e.g., scheduled, manual, or zero-touch).

templateIDstring

ID of the OS deployment template that was used.

templateNamestring

Name of the OS deployment template that was used.

deploymentInitiatedBystring

Username of the person who started the deployment.

deployedComputerDetailsJSON Object

Hardware details of the target machine at the time of deployment (modelName, macAddress, diskSize, manufacturerName, serviceTag, hardDiskType, diskDriveType, biosMode, ramSize, secureBootMode, architecture).

Show Sub-Attributes
modelNamestring

Model name of the target machine (e.g., Latitude 5520).

macAddressstring

MAC address of the target machine's network adapter.

diskSizestring

Total disk size of the target machine (e.g., 50.0 GB).

manufacturerNamestring

Hardware manufacturer of the target machine (e.g., Dell Inc.).

serviceTagstring

Service tag or serial number of the target machine.

hardDiskTypestring

Code identifying the disk type (e.g., 1 for SSD).

diskDriveTypestring

Human-readable disk type (e.g., SSD (Solid State Drive)).

biosModestring

BIOS mode of the machine (e.g., UEFI or Legacy BIOS).

ramSizestring

Total RAM of the target machine (e.g., 3.10 GB).

secureBootModestring

Whether Secure Boot is enabled (On or Off).

architecturestring

CPU architecture of the target machine (e.g., 64 bit).

imageDetailsJSON Object

OS image used for this deployment, including image metadata, repository details, and the source machine details.

Show Sub-Attributes
imageIDstring

ID of the OS image that was deployed.

imageNamestring

Name of the OS image.

imagePathstring

Network path (UNC) to the image file on the repository.

osNamestring

Name of the operating system in the image.

isOfflineImageboolean

True if the image is an offline image (WIM/ESD format).

isImageAvailableboolean

True if the image file is currently accessible on the repository.

repositoryIDstring

ID of the image repository where the image is stored.

repositoryNamestring

Name of the image repository.

repositoryPathstring

Network path to the image repository.

imageSizestring

Total size of the image file in bytes.

imageCreatedBystring

Username of the person who created the image.

remoteOfficeIDstring

ID of the remote office that hosts this image.

remoteOfficeNamestring

Name of the remote office that hosts this image.

imagedComputerDetailsJSON Object

Hardware and OS details of the source machine from which the image was captured.

Show Sub-Attributes
resourceIDstring

Resource ID of the source machine.

computerNamestring

Computer name of the source machine.

ipAddressstring

IP address of the source machine.

fqdnstring

Fully qualified domain name of the source machine. Empty if not domain-joined.

operatingSystemstring

OS installed on the source machine at the time the image was captured.

domainIDstring

ID of the domain the source machine was joined to.

domainNamestring

Domain or workgroup name of the source machine.

macAddressstring

MAC address of the source machine.

serviceTagstring

Service tag or serial number of the source machine.

modelNamestring

Hardware model of the source machine.

manufacturerNamestring

Hardware manufacturer of the source machine.

diskSizestring

Total disk size of the source machine.

diskStylestring

Partition style of the source machine's disk (GPT or MBR).

diskSectorSizestring

Disk sector size (e.g., 512 Bytes).

diskDriveTypestring

Drive type (e.g., SSD or HDD).

biosModestring

BIOS mode of the source machine.

ramSizestring

RAM size in a human-readable format.

ramSizeValuestring

RAM size in bytes.

processorNamestring

CPU model of the source machine.

secureBootModestring

Whether Secure Boot was enabled on the source machine.

architecturestring

CPU architecture of the source machine (e.g., 64 bit).

windows11Variantboolean

True if the OS captured is a Windows 11 variant.

imageReplicatedDetailsarray

List of remote offices this image has been replicated to. Empty if not replicated.

imagedComputerDetailsJSON Object

Hardware and OS details of the source machine from which the image was captured. Mirrors imageDetails.imagedComputerDetails for top-level access.

Show Sub-Attributes
resourceIDstring

Resource ID of the source machine.

computerNamestring

Computer name of the source machine.

ipAddressstring

IP address of the source machine.

fqdnstring

Fully qualified domain name of the source machine. Empty if not domain-joined.

operatingSystemstring

OS installed on the source machine at the time the image was captured.

domainIDstring

ID of the domain the source machine was joined to.

domainNamestring

Domain or workgroup name of the source machine.

macAddressstring

MAC address of the source machine.

serviceTagstring

Service tag or serial number of the source machine.

modelNamestring

Hardware model of the source machine.

manufacturerNamestring

Hardware manufacturer of the source machine.

diskSizestring

Total disk size of the source machine.

diskStylestring

Partition style of the source machine's disk (GPT or MBR).

diskSectorSizestring

Disk sector size (e.g., 512 Bytes).

diskDriveTypestring

Drive type (e.g., SSD or HDD).

biosModestring

BIOS mode of the source machine.

ramSizestring

RAM size in a human-readable format.

ramSizeValuestring

RAM size in bytes.

processorNamestring

CPU model of the source machine.

secureBootModestring

Whether Secure Boot was enabled on the source machine.

architecturestring

CPU architecture of the source machine (e.g., 64 bit).

windows11Variantboolean

True if the OS captured is a Windows 11 variant.

diskInfoJSON Object

Disk configuration applied to the target machine: disk number, erase flag, adjustment and conversion actions, and per-partition details.

Show Sub-Attributes
diskNumberinteger

Physical disk number on the target machine targeted for deployment.

isDiskEraseboolean

True if the disk was fully erased before the OS image was applied.

diskAdjustmentActioninteger

Disk size adjustment action performed (e.g., 1 = resize to fit image).

diskStyleConversionActioninteger

Partition style conversion performed (e.g., 0 = no conversion, 1 = MBR to GPT).

partitionsJSON Array

List of partitions on the disk and their details.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
partitionIDstring

ID of this partition.

partitionNamestring

Label of the partition (e.g., EFI system partition[Hidden]). Empty for the primary OS partition.

partitionLetterstring

Drive letter assigned to the partition (e.g., C). Empty for hidden or system partitions.

partitionTypeinteger

Partition type: 1 = primary data partition, 2 = hidden or system partition.

fileSystemstring

File system type of the partition (e.g., NTFS). Empty for EFI partitions.

totalSpacestring

Total size of the partition in bytes.

usedSpacestring

Amount of space used on the partition in bytes.

isEncryptedboolean

True if the partition is encrypted with BitLocker.

isPartitionShrunkboolean

True if the partition was resized (shrunk) during deployment.

isPartitionOverwriteboolean

True if the partition data was overwritten during deployment.

postDeploymentActionsJSON Object

Actions configured to run on the target machine after the OS image was applied: computer name, domain join, user accounts, and machine action settings.

Show Sub-Attributes
computerNamestring

Computer name assigned to the target machine after deployment.

computerDescriptionstring

Optional description set on the machine after deployment.

assignComputerNameManuallyboolean

True if the computer name was set manually rather than from a naming rule.

machineActioninteger

Action taken on the machine after deployment completed (e.g., 1 = shutdown, 2 = restart).

machineActionLabelstring

Human-readable description of the machine action (e.g., Machine Shutdown).

sidActioninteger

Security Identifier (SID) action applied after deployment (e.g., 0 = keep existing SID).

sidActionLabelstring

Human-readable description of the SID action.

userSidAssignedboolean

True if a SID was assigned to user accounts after deployment.

retainTemplateSettingsboolean

True if the deployment template's default settings were kept without modification.

deleteExistingUsersboolean

True if existing user accounts were deleted before new accounts were added.

domainInfoJSON Object

Domain or workgroup the machine was joined to after deployment.

Show Sub-Attributes
domainIDstring

ID of the domain or workgroup.

domainNamestring

Name of the domain or workgroup the machine was joined to.

adDomainNamestring

Active Directory domain name. Shown as -- if in a workgroup.

isADDomainboolean

True if joined to an Active Directory domain; false if in a workgroup.

credentialIDstring

ID of the credential record used to join the domain.

credentialNamestring

Display name of the credential record.

credentialUserNamestring

Username from the credential used for domain join.

ouInfoJSON Object

Organisational Unit the machine was placed in during domain join. Absent if no OU was configured.

Show Sub-Attributes
ouNamestring

Friendly name of the target Organizational Unit.

distinguishedNamestring

Full LDAP distinguished name of the target OU.

userAccountsJSON Object

User account configuration applied post-deployment.

Show Sub-Attributes
localUsersJSON Object

Local user IDs to provision on the deployed machine.

Show Sub-Attributes
userIDsarray

IDs of pre-configured local users in OS Deployer. Max 5000 entries.

domainUsersJSON Array

Domain users / groups to add to the machine. Max 5000 entries.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
userNamestring

SAM account name of the domain user.

groupNamestring

Local group on the deployed machine to add the user to (e.g., Administrators).

guidstring

Object GUID of the domain user, used for lookup if userName changes.

deleteExistingUsersboolean

If true, existing local accounts are removed before applying this configuration.

userDeletionAccountsJSON Array

List of user accounts deleted from the machine post-deployment.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
userIDstring

ID of the user account that was deleted.

userNamestring

Username of the deleted account.

groupNamestring

Group the deleted user belonged to (e.g., Administrators).

userTypeinteger

Type of user account: 0 = local user.

userTypeValuestring

Human-readable user type label (e.g., Local User).

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

A deployment that completed successfully (zero-touch, domain-joined, with disk info and post-deployment actions)

Copied!
  {
    "deploymentType": 5,
    "deployedComputerDetails": {
      "modelName": "Virtual Machine",
      "macAddress": "00:15:5D:20:50:07",
      "diskSize": "50.0 GB",
      "manufacturerName": "Microsoft Corporation",
      "serviceTag": "R7N0CV07M11628A",
      "hardDiskType": "1",
      "diskDriveType": "SSD (Solid State Drive)",
      "biosMode": "UEFI BIOS",
      "ramSize": "3.10 GB",
      "secureBootMode": "On",
      "architecture": "64 bit"
    },
    "templateName": "str-id-6",
    "imageDetails": {
      "isOfflineImage": false,
      "imageID": "3901",
      "imageName": "golden-server",
      "imagePath": "\\\\mt-2\\repo\\osd-ec-master\\golden-server.osdi",
      "osName": "Microsoft Windows Server 2022",
      "repositoryName": "ImageRepository74",
      "imageCreatedBy": "admin",
      "isImageAvailable": true,
      "repositoryPath": "\\\\mt-2\\repo\\osd-ec-master",
      "repositoryID": "5401",
      "imageSize": "6042692203",
      "remoteOfficeID": "1",
      "remoteOfficeName": "Local Office",
      "imagedComputerDetails": {
        "windows11Variant": false,
        "resourceID": "7501",
        "fqdn": "",
        "manufacturerName": "Microsoft Corporation",
        "ipAddress": "10.71.33.208",
        "diskDriveType": "HDD (Hard Disk Drive)",
        "biosMode": "Legacy BIOS",
        "ramSize": "1023 MB",
        "operatingSystem": "Microsoft Windows Server 2022",
        "domainID": "18518",
        "modelName": "Virtual Machine",
        "diskSize": "40.0 GB",
        "macAddress": "00:15:5D:1C:76:49",
        "computerName": "MT1-SERVER",
        "diskStyle": "MBR",
        "diskSectorSize": "512 Bytes",
        "domainName": "WORKGROUP",
        "serviceTag": "7984-1004-2384-9411-9089-4482-36",
        "processorName": "Intel(R) Core(TM) i7-9850H CPU @ 2.60GHz",
        "ramSizeValue": "1073270784",
        "secureBootMode": "Off",
        "architecture": "64 bit"
      },
      "imageReplicatedDetails": []
    },
    "postDeploymentActions": {
      "machineAction": 1,
      "deleteExistingUsers": false,
      "domainInfo": {
        "domainName": "KDOMAIN",
        "credentialID": "7501",
        "isADDomain": true,
        "credentialName": "KDOMAIN_root",
        "domainID": "29405",
        "credentialUserName": "administrator"
      },
      "assignComputerNameManually": true,
      "retainTemplateSettings": false,
      "ouInfo": {
        "ouID": "602",
        "distinguishedName": "OU=Domain Controllers,DC=kdomain,DC=in",
        "ouName": "Domain Controllers"
      },
      "userAccounts": {
        "localUsers": [
          {
            "userTypeValue": "Local User",
            "groupName": "Administrators",
            "userType": 0,
            "userName": "OSD",
            "userID": "601"
          }
        ],
        "domainUsers": [
          {
            "userTypeValue": "Domain User",
            "groupName": "Administrators",
            "guid": "3e587205dc38f84094200e6734c8f8a0",
            "userType": 1,
            "userName": "Guest",
            "userID": "665"
          }
        ]
      },
      "machineActionLabel": "Machine Shutdown",
      "sidActionLabel": "Retain existing SID as in image",
      "userSidAssigned": true,
      "computerName": "CSS_COMP_NAMEw",
      "userDeletionAccounts": [
        {
          "userTypeValue": "Local User",
          "groupName": "System Managed Accounts Group",
          "userType": 0,
          "userName": "DefaultAccount",
          "userID": "3303"
        },
        {
          "userTypeValue": "Local User",
          "groupName": "Guests",
          "userType": 0,
          "userName": "Guest",
          "userID": "3302"
        },
        {
          "userTypeValue": "Local User",
          "groupName": "Administrators",
          "userType": 0,
          "userName": "Test",
          "userID": "3301"
        }
      ],
      "sidAction": 0,
      "computerDescription": "ddfd"
    },
    "deploymentInitiatedBy": "admin",
    "templateID": "4809",
    "diskInfo": {
      "partitions": [
        {
          "fileSystem": "NTFS",
          "partitionName": "System Reserved",
          "usedSpace": "33374208",
          "partitionID": "3901",
          "isEncrypted": false,
          "isPartitionShrunk": false,
          "partitionLetter": "",
          "totalSpace": "104857600",
          "partitionType": 2,
          "isPartitionOverwrite": false
        },
        {
          "fileSystem": "NTFS",
          "partitionName": "",
          "usedSpace": "7425904640",
          "partitionID": "3902",
          "isEncrypted": false,
          "isPartitionShrunk": false,
          "partitionLetter": "C",
          "totalSpace": "42292215808",
          "partitionType": 1,
          "isPartitionOverwrite": false
        },
        {
          "fileSystem": "NTFS",
          "partitionName": "Recovery",
          "usedSpace": "462389248",
          "partitionID": "3903",
          "isEncrypted": false,
          "isPartitionShrunk": false,
          "partitionLetter": "",
          "totalSpace": "549453824",
          "partitionType": 2,
          "isPartitionOverwrite": false
        }
      ],
      "diskAdjustmentAction": 1,
      "diskStyleConversionAction": 1,
      "diskNumber": 0,
      "isDiskErase": true
    },
    "imagedComputerDetails": {
      "windows11Variant": false,
      "resourceID": "7501",
      "fqdn": "",
      "manufacturerName": "Microsoft Corporation",
      "ipAddress": "10.71.33.208",
      "diskDriveType": "HDD (Hard Disk Drive)",
      "biosMode": "Legacy BIOS",
      "ramSize": "1023 MB",
      "operatingSystem": "Microsoft Windows Server 2022",
      "domainID": "18518",
      "modelName": "Virtual Machine",
      "diskSize": "40.0 GB",
      "macAddress": "00:15:5D:1C:76:49",
      "computerName": "MT1-SERVER",
      "diskStyle": "MBR",
      "diskSectorSize": "512 Bytes",
      "domainName": "WORKGROUP",
      "serviceTag": "7984-1004-2384-9411-9089-4482-36",
      "processorName": "Intel(R) Core(TM) i7-9850H CPU @ 2.60GHz",
      "ramSizeValue": "1073270784",
      "secureBootMode": "Off",
      "architecture": "64 bit"
    }
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.