Suspend an APD Task Deprecating soon

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Suspending a APD task.

This API endpoint is deprecating soon

View new endpoint   >

Request URL

https://{serverurl}/api/1.4/patch/suspendAPDTask Copied!

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

tasknamestringOptional

Name of the APD task to act on. Get the task names from Get APD Tasks api

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/api/1.4/patch/suspendAPDTask \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
message_typestring

Action identifier: suspendAPDTask

message_responseJSON Object

Suspend result payload

Show Sub-Attributes
suspendapdtaskJSON Object

Suspend action result

Show Sub-Attributes
statusstring

Action result message (e.g., task has been deleted/resumed/suspended/modified successfully)

message_versionstring

API version: 1.4

statusstring

Overall operation status: success

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Error code: APD_TASK_NOT_FOUND for task name mismatch, APD_ACTION_FAILED for action failures

errorstring

Error type: APD_TASK_NOT_FOUND or APD_ACTION_FAILED

error_descriptionstring

Detailed failure reason: task not found, task already in target state, or insufficient permissions

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

Copied!
  {
    "message_type": "suspendAPDTask",
    "message_response": {
      "suspendapdtask": {
        "status": "task has been suspended successfully"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
▼ Show full

Sample Response: HTTP 400

APD task with the given name does not exist

Copied!
  {
    "error_code": "APD_TASK_NOT_FOUND",
    "error": "APD_TASK_NOT_FOUND",
    "error_description": "The specified APD task was not found"
  }
                
▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full

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.