Retrieves prerequisite information required to display the scheduled power operation tasks list

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

Retrieves prerequisite information required to display the scheduled power operation tasks list

Endpoints

Request URL

https://{serverurl}/dcapi/tools/shutdown/tasks

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/shutdown/tasks \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Array of supported operation type objects with id and name: Shutdown, Restart, Logoff, Lock, Hibernate

platformsarray

Array of supported platform objects with id, name, and isEnabled flag

isFeatureEnabledboolean

true if the Shutdown/Restart feature is enabled in the current license

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "isFeatureEnabled": true,
    "operationTypes": [
      {
        "name": "Shutdown",
        "id": 1
      },
      {
        "name": "Restart",
        "id": 2
      },
      {
        "name": "Logoff",
        "id": 3
      },
      {
        "name": "Lock",
        "id": 4
      },
      {
        "name": "Hibernate",
        "id": 5
      }
    ],
    "platforms": [
      {
        "isEnabled": true,
        "name": "Windows",
        "id": 1
      },
      {
        "isEnabled": true,
        "name": "macOS",
        "id": 2
      }
    ]
  }
                
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.