hosting
PUT /v1/sites/{siteId}/scheduled-tasks/{taskId}
Replace a site's scheduled task.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте sites.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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 консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
siteId (path) | Uuid | Иә | Site ID (UUIDv7). |
taskId (path) | string | Иә | The task id returned by listSiteScheduledTasks. |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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