# Force Stop Inprogress Deployment

Forces an in-progress deployment to terminate immediately, bypassing the graceful stop sequence. Use this when the standard stop endpoint fails to abort the deployment in a timely manner.

## Endpoints

PUT `/emsapi/osdeployer/deployments/{deploymentId}/forcestop`

## Request

### Request URL

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

### Scope

```text
OSDDeployment.UPDATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

- **Accept** `string` — Mandatory: `application/deploymentStoppedStatus.v1+json`

#### Path Parameters

- **deploymentId** `string` — Mandatory

  ID of the OS Deployer Deployment

### Sample Request

```curl
curl --request PUT \
  --url https://appdomain/emsapi/osdeployer/deployments/{deploymentId}/forcestop \
  --header 'Accept: application/deploymentStoppedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body: `application/deploymentStoppedStatus.v1+json`

- `JSON Object`
  - **isDeploymentStopped** `boolean`

    True if the deployment was successfully force-stopped.

### Possible Response Codes

- **200** — HTTP code

### Sample Response: HTTP 200

Deployment was force-stopped

```json
{
  "isDeploymentStopped": true
}
```

## API Rate Limit

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