# Suspends an active deployment, preventing further execution until resumed

Used to suspend the deployment

## Endpoint

**PUT** `/intelligence/api/deployments/{deploymentId}/suspend`

## Request

### Request URL

`https://{server-hostname}:8383/intelligence/api/deployments/{deploymentId}/suspend`

### Scope

`DEX.UPDATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Content-Type** `string` **Mandatory**: `application/deploymentSuspend.v1+json`
- **Accept** `string` **Mandatory**: `application/deploymentSuspend.v1+json`

#### Path Parameters

- **deploymentId** `string` **Mandatory**

### Sample Request

```curl
curl --request PUT \
  --url https://appdomain/intelligence/api/deployments/{deploymentId}/suspend \
  --header 'Accept: application/deploymentSuspend.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentSuspend.v1+json'
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **message** `string`: Confirmation message that the deployment was suspended

### Sample Response: HTTP 200

```json
{
  "message": "Deployment 'Onboarding Deployment' has been suspended successfully."
}
```

## Rate Limit

![Help icon](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.