# Fetch real-time status of a deployment

Returns the current execution stage, percentage progress, and any error details for a running or finished deployment.

## Endpoint

`GET /emsapi/osdeployer/deployments/{deploymentId}/status`

## Request URL

```text
https://{server-hostname}:8383/emsapi/osdeployer/deployments/{deploymentId}/status
```

## Scope

```text
OSDDeployment.READ
```

## Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Request Headers

- **Accept** `string` — Mandatory
  - `application/deploymentStatus.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}/status \
  --header 'Accept: application/deploymentStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — `application/deploymentStatus.v1+json`

`JSON Object`

- **deploymentStatus** `integer`
  - Current status of the deployment (e.g., 1 = success, 0 = failed, 2 = in progress).
- **deploymentRemarks** `string`
  - Human-readable description of the current or final deployment status.
- **deploymentDuration** `string`
  - Total time elapsed since the deployment started (e.g., 2 Mins 50 Secs).
- **deploymentStartTime** `string`
  - Timestamp when the deployment started (e.g., Apr 9, 2024 07:59 AM).
- **deploymentCompletedTime** `string`
  - Timestamp when the deployment finished.
- **remoteOfficeID** `string`
  - ID of the remote office where this deployment ran. Present only for remote office deployments.
- **isComputerNameAssigned** `boolean`
  - True if the computer name was successfully set on the machine after deployment.
- **deploymentReadKBurl** `string`
  - Link to a knowledge base article for troubleshooting. Present only when the deployment failed with an error code.
- **isCredentialError** `boolean`
  - True if the deployment failed due to a credential authentication error. Present only on failure.
- **isNetworkError** `boolean`
  - True if the deployment failed due to a network connectivity error. Present only on failure.
- **isTargetDiskError** `boolean`
  - True if the deployment failed due to a disk error on the target machine. Present only on failure.
- **imageDetails** `JSON Object`
  - Details of the OS image replicated at the remote office. Present only for remote office deployments.
- **componentInstallationCompletedPercent** `integer`
  - Percentage of agent/component installation completed on the target machine. Present only for zero-touch deployments.
- **mediaBootingCompletedPercent** `integer`
  - Percentage of the media booting phase completed. Present only for zero-touch deployments.
- **overallProgress** `JSON Object`
  - Combined transfer progress across all partitions being deployed.
- **partitionsProgress** `JSON Array`
  - Transfer progress broken down per partition.
- **postDeploymentProgress** `JSON Object`
  - Tracks the results of all actions taken after the OS image was applied.

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

### Deployment currently applying the image

```json
{
  "deploymentDuration": "2 Mins 50 Secs",
  "deploymentStatus": 2,
  "deploymentRemarks": "Deployment in progress",
  "overallProgress": {
    "estimatedTime": "3 Mins",
    "completedSize": "5368709120",
    "totalSize": "11444242432",
    "completedPercent": 47,
    "speed": "133 MB/sec"
  },
  "deploymentStartTime": "Apr 9, 2024 07:59 AM",
  "isComputerNameAssigned": false
}
```

### Deployment failed due to a credential error

```json
{
  "deploymentDuration": "5 Mins 12 Secs",
  "deploymentStatus": 0,
  "isNetworkError": false,
  "deploymentRemarks": "Domain join failed: credentials rejected",
  "deploymentReadKBurl": "https://support.example.com/kb/OSD-1042",
  "deploymentStartTime": "Apr 9, 2024 07:59 AM",
  "isComputerNameAssigned": false,
  "isCredentialError": true,
  "isTargetDiskError": false,
  "deploymentCompletedTime": "Apr 9, 2024 08:04 AM"
}
```

### Deployment completed with post-deployment actions (domain join, user addition, driver install)

```json
{
  "deploymentDuration": "2 Mins 10 Secs",
  "deploymentStatus": 7,
  "deploymentRemarks": "Post Deployment completed successfully",
  "overallProgress": {
    "estimatedTime": "1 Sec",
    "completedSize": "8369957888",
    "totalSize": "8369957888",
    "completedPercent": 100,
    "speed": "63 MB/sec"
  },
  "deploymentStartTime": "Jul 8, 2026 09:18 PM",
  "postDeploymentProgress": {
    "groupZeroStatus": {
      "groupStatusCount": 4,
      "groupStatus": 1,
      "groupTaskStatusDetails": {
        "driverInstallationStatus": {
          "duration": "4 Secs",
          "remarks": "Completed",
          "status": 1
        },
        "postDeploymentActionStatus": {
          "duration": "--",
          "remarks": "Completed",
          "status": 1
        },
        "recoveryDetails": {
          "duration": "2 Secs",
          "remarks": "Completed",
          "status": 1
        },
        "diskStyleConversionStatus": {
          "duration": "7 Secs",
          "readKBurl": "",
          "remarks": "Success",
          "status": 1
        },
        "diskAdjustmentStatus": {
          "duration": "1 Min 1 Secs",
          "readKBurl": "",
          "remarks": "Completed",
          "status": 1
        }
      }
    },
    "deploymentDriverDetails": {
      "deviceID": [
        "902",
        "901"
      ]
    },
    "groupOneStatus": {
      "groupStatusCount": 7,
      "groupStatus": 1,
      "groupTaskStatusDetails": {
        "driverInstallationStatus": {
          "duration": "1 Sec",
          "remarks": "Completed",
          "status": 1
        },
        "computerNameStatus": {
          "duration": "15 Secs",
          "readKBurl": "",
          "computerName": "CHANGED-at-DEP",
          "remarks": "Completed",
          "status": 1
        },
        "ouStatus": {
          "duration": "--",
          "readKBurl": "",
          "remarks": "Completed",
          "status": 1
        },
        "postDeploymentActionStatus": {
          "duration": "2 Mins 1 Secs",
          "remarks": "Completed",
          "status": 1
        },
        "domainStatus": {
          "duration": "8 Mins 53 Secs",
          "readKBurl": "",
          "remarks": "Completed",
          "status": 1
        },
        "localUserAdditionStatus": {
          "duration": "1 Sec",
          "userDetailsList": [
            {
              "duration": "1 Sec",
              "readKBurl": "",
              "userID": "901",
              "remarks": "Completed",
              "status": 1
            }
          ],
          "remarks": "Success",
          "status": 1
        },
        "domainUserAdditionStatus": {
          "duration": "1 Sec",
          "userDetailsList": [
            {
              "duration": "1 Sec",
              "readKBurl": "",
              "userID": "602",
              "remarks": "Completed",
              "status": 1
            }
          ],
          "remarks": "Success",
          "status": 1
        }
      }
    },
    "groupTwoStatus": {
      "groupStatusCount": 1,
      "groupStatus": 1,
      "groupTaskStatusDetails": {
        "driverInstallationStatus": {
          "duration": "1 Sec",
          "remarks": "Completed",
          "status": 1
        }
      }
    },
    "overallStatus": {
      "overallUserDeletionStatus": {
        "remarks": "Users not configured",
        "status": -4
      },
      "overallDriverStatus": {
        "remarks": "Installation completed",
        "status": 1
      },
      "overallUsmtStatus": {
        "remarks": "User profiles not configured",
        "status": -4
      },
      "overallUserAdditionStatus": {
        "remarks": "Completed",
        "status": 1
      },
      "overallApplicationStatus": {
        "remarks": "Applications not configured",
        "status": -4
      }
    }
  },
  "remoteOfficeID": "1",
  "isComputerNameAssigned": true,
  "deploymentCompletedTime": "Jul 8, 2026 09:20 PM",
  "partitionsProgress": [
    {
      "estimatedTime": "1 Sec",
      "completedSize": "104857088",
      "totalSize": "104857088",
      "partitionID": "3901",
      "completedPercent": 100,
      "speed": "63 MB/sec"
    },
    {
      "estimatedTime": "1 Sec",
      "completedSize": "7715647488",
      "totalSize": "7715647488",
      "partitionID": "3902",
      "completedPercent": 100,
      "speed": "63 MB/sec"
    },
    {
      "estimatedTime": "1 Sec",
      "completedSize": "549453312",
      "totalSize": "549453312",
      "partitionID": "3903",
      "completedPercent": 100,
      "speed": "63 MB/sec"
    }
  ]
}
```

![ ](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.