hosting

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

Replace a site's scheduled task.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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`.

بدنه درخواست

نام	نوع	الزامی	چیست
`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

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