hosting

PUT /v1/sites/{siteId}/scheduled-tasks/{taskId}

Replace a site's scheduled task.

Усі кінцеві точки hosting

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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`.

Параметри

НазваТипОбов'язковеЩо це таке
siteId (path)UuidТакSite ID (UUIDv7).
taskId (path)stringТакThe task id returned by `listSiteScheduledTasks`.

Тіло запиту

НазваТипОбов'язковеЩо це таке
schedulestringТак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 s…
commandstringТак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_outputstringНі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 forma…
enabledbooleanНіWhether the task runs. ⛔ Honoured by `updateSiteScheduledTask` and **ignored by `createSiteScheduledTask`** — a newly created task is always active, and pausing one is a subsequ…

Відповідь

НазваТипОбов'язковеЩо це таке
idstringТакThe task's identifier at the vendor, used to update or delete it.
schedulestringТакThe crontab expression, carried **verbatim**. A customer who typed `*/15 * * * *` sees exactly that back, never a normalised rewriting of it.
commandstringТакThe command the vendor runs, as the site's own user.
enabledbooleanТак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…
email_outputstringТакWhere the task's output is mailed, or `""` when the vendor mails it nowhere.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 409 · 422 · 429 · 503