# Suspend an APD Task

Suspends an active Automated Patch Deployment (APD) task.

## Endpoint

`POST /dcapi/patch/autopatchdeployment/suspend`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/patch/autopatchdeployment/suspend`

### Scope

`PatchMgmt.CREATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Body

`application/json`

JSON object:

- **taskName** `string` — Mandatory  
  Name of the APD task to operate on

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/patch/autopatchdeployment/suspend \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"taskName":"My APD Task"}'
```

### Sample Request Body

Suspend by task name

```json
{
  "taskName": "My APD Task"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

JSON object:

- **status** `string`  
  Action result message (e.g., task has been suspended successfully)

### Possible Response Codes

- **200** — HTTP code

### Sample Response: HTTP 200

Task suspended

```json
{
  "status": "task has been suspended successfully"
}
```

## Rate Limits

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