# Fetch deployment metadata for a single deployment Returns the task, device, template, image, and timestamp details for the specified deployment ID. ## Endpoint `GET /emsapi/osdeployer/deployments/{deploymentId}` ## Request ### Request URL `https://{server-hostname}:8383/emsapi/osdeployer/deployments/{deploymentId}` ### Scope `OSDDeployment.READ` ### Header `Authorization: d92d4xxxxxxxxxxxxx15f52` ### Request Parameters #### Request Headers - **Accept** `string` — **Mandatory** - `application/deploymentDetails.v1+json` #### Path Parameters - **deploymentId** `string` — **Mandatory** - ID of the OS Deployer deployment ### Sample Request ```bash curl --request GET \ --url https://appdomain/emsapi/osdeployer/deployments/{deploymentId} \ --header 'Accept: application/deploymentDetails.v1+json' \ --header 'Authorization: d92d4xxxxxxxxxxxxx15f52' ``` ## Response ### Response Parameters #### HTTP 200 Response body: `application/deploymentDetails.v1+json` - `JSON Object` - **deploymentType** `integer` - Indicates how the deployment was triggered (e.g., scheduled, manual, or zero-touch). - **templateID** `string` - ID of the OS deployment template that was used. - **templateName** `string` - Name of the OS deployment template that was used. - **deploymentInitiatedBy** `string` - Username of the person who started the deployment. - **deployedComputerDetails** `JSON Object` - Hardware details of the target machine at the time of deployment (modelName, macAddress, diskSize, manufacturerName, serviceTag, hardDiskType, diskDriveType, biosMode, ramSize, secureBootMode, architecture). - **imageDetails** `JSON Object` - OS image used for this deployment, including image metadata, repository details, and the source machine details. - **imagedComputerDetails** `JSON Object` - Hardware and OS details of the source machine from which the image was captured. Mirrors imageDetails.imagedComputerDetails for top-level access. - **diskInfo** `JSON Object` - Disk configuration applied to the target machine: disk number, erase flag, adjustment and conversion actions, and per-partition details. - **postDeploymentActions** `JSON 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. ### Possible Response Codes - **200** `HTTP code` ### Sample Response: HTTP 200 A deployment that completed successfully (zero-touch, domain-joined, with disk info and post-deployment actions) ```json { "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" } } ``` ![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.