Creates a new scheduled power operation task (shutdown, restart, log off, hibernate, or lock) targeting the specified computers or groups. Accepts a full task configuration JSON body including task name, operation type, platform, shutdown message, postpone or skip options, and schedule settings.
post /dcapi/tools/shutdown/tasks
https://{serverurl}/dcapi/tools/shutdown/tasks
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Refine selections that further restrict the main target — only resources matching these entries are included.
Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.
Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.
Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.
Display name of the target entity.
Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.
'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.
Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.
Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.
Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.
Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.
Display name of the target entity.
Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.
'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.
Refine selections that further restrict the main target — only resources matching these entries are included.
Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.
Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.
Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.
Display name of the target entity.
Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.
'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.
Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.
Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.
Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.
Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.
Display name of the target entity.
Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.
'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.
curl --request POST \
--url https://appdomains/dcapi/tools/shutdown/tasks \
--header 'Accept: application/saveShutdownTask.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/shutdownTaskParams.v1+json' \
--data '{}' {
"targetData": {
"envType": 0,
"targetValue": "Engineering",
"targetType": "CustomGroup"
},
"scheduleJsonObj": {
"dailyTime": "03/25/2026, 23:00",
"scheduleType": "daily",
"taskTimeZone": "America/New_York",
"dailyIntervalType": "everyDay"
},
"taskDetails": {
"mode": "new",
"postPoneEnabled": true,
"operationStr": "Shutdown",
"shutdownTimeout": 300,
"skipEnabled": false,
"taskName": "Nightly Shutdown",
"shutdownMessage": "System will shutdown in 5 minutes.",
"taskPlatformID": 1,
"operation": 1
}
}
Result of the operation: success or failure
Unique identifier of the created or saved task
{
"taskId": 5,
"status": "success"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.