hosting
PUT /v1/sites/{siteId}/scheduled-tasks/{taskId}
Replace a site's scheduled task.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს sites.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/scheduled-tasks/{taskId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "schedule": <string>, "command": <string> }'შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
⛔ The body is the WHOLE row, every time. the platform's update replaces the task rather than patching it, so a request carrying only the field that moved blanks the rest — which, on a pause, means losing the schedule and the command the customer wrote. PUT and not PATCH says exactly that: the body is the task's desired end state. The same validation as createSiteScheduledTask runs first, so a bad expression is 422 before the vendor is asked and the existing task is left alone. 404 for a site with no managed hosting package, and for a task id that is not on it. Requires sites.view and sites.panel_access.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
siteId (path) | Uuid | დიახ | Site ID (UUIDv7). |
taskId (path) | string | დიახ | The task id returned by listSiteScheduledTasks. |
მოთხოვნის სხეული
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
schedule | string | დიახ | A five- or six-field crontab expression. Validated before the vendor is called; ⛔ a newline anywhere in it is refused, because a crontab is lines and one embedded newline is a… |
command | string | დიახ | The command to run. Capped at the length the vendor's crond accepts — anything longer belongs in a script file the task then schedules. |
email_output | string | არა | Where to mail the task's output. An email address, or empty to mail it nowhere — which is why this carries no format: email: the empty string is a valid value here and a format… |
enabled | boolean | არა | Whether the task runs. ⛔ Honoured by updateSiteScheduledTask and ignored by createSiteScheduledTask — a newly created task is always active, and pausing one is a… |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
id | string | დიახ | The task's identifier at the vendor, used to update or delete it. |
schedule | string | დიახ | The crontab expression, carried verbatim. A customer who typed */15 * * * * sees exactly that back, never a normalised rewriting of it. |
command | string | დიახ | The command the vendor runs, as the site's own user. |
enabled | boolean | დიახ | Whether the task currently runs. ⛔ An absent vendor flag reads as false, never true — reporting a paused job as running is how a customer stops investigating the thing that is… |
email_output | string | დიახ | Where the task's output is mailed, or "" when the vendor mails it nowhere. |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 409 · 422 · 429 · 503