Disable (Task)

URL:
https://<root>/system/tasks/<taskID>/disable
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.9

Description

The disable operation disables a specific task and suspends any upcoming runs scheduled for the task.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the disable operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/system/tasks/fdbbc58261544b2f82b61c8111a08f16/disable HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson&token=bnwCK0Wlwj9fIJrwWq5o8LgV__ibaG6Lw_idwH8HA2c3pnYoTB1_odgA0MIC7p8oKQr8sYVFTMbpEerYQf4pIx34a7QGyBTUPtx5VYpzI_xyi68qGVUOmO8ouQqWGQEDWW6Jc0dJrIOVZBJ4x3aHyaBgPnuUWZitcGssH6QYH47Nuk_b6NRChHBi_EglJutuOPbCKc96TmbfKkH7atbfCSecvv3nnVHYvC1s1j02ZZWqt6Q_idRuVhQVcfBbFkFw

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.