# Resume an APD Task

Resuming a APD task.

**This API endpoint is deprecating soon**

## Endpoint

`POST /api/1.4/patch/resumeAPDTask`

## Request URL

https://[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/1.4/patch/resumeAPDTask

## Scope

`DesktopCentralCloud.PatchMgmt.UPDATE`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Query Parameters

- **taskname** (`string`, Optional): Provide name of the apd task
- **customerid** (`long`, Optional)

### Request Body

`application/json`

- `JSON Object`
  - **taskname** (`string`, Mandatory): Name of the APD task to resume

### Sample Request

```curl
curl --request POST \
  --url https://appdomains/api/1.4/patch/resumeAPDTask \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"taskname":"windows create task"}'
```

### Sample Request Body

Resume an APD Task by name

```json
{
  "taskname": "windows create task"
}
```

## Response Parameters

### HTTP Code 200

#### Response Body — application/json

- `JSON Object`
  - **message_type** (`string`): Action identifier: resumeAPDTask
  - **message_response** (`JSON Object`): Resume result payload
    - **resumeapdtask** (`JSON Object`): Resume action result
  - **message_version** (`string`): API version: 1.4
  - **status** (`string`): Overall operation status: success

### Sample Response: HTTP 200

APD task resumed successfully

```json
{
  "message_type": "resumeAPDTask",
  "message_response": {
    "resumeapdtask": {
      "status": "task has been resumed successfully"
    }
  },
  "message_version": "1.4",
  "status": "success"
}
```

### HTTP Code 400

#### Response Body — application/json

- `JSON Object`
  - **error_code** (`string`): Error code: APD_TASK_NOT_FOUND for task name mismatch, APD_ACTION_FAILED for action failures
  - **error** (`string`): Error type: APD_TASK_NOT_FOUND or APD_ACTION_FAILED
  - **error_description** (`string`): Detailed failure reason: task not found, task already in target state, or insufficient permissions

### Sample Response: HTTP 400

APD task with the given name does not exist

```json
{
  "error_description": "The specified APD task was not found",
  "error_code": "APD_TASK_NOT_FOUND",
  "error": "APD_TASK_NOT_FOUND"
}
```

## Rate Limit

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