hosting

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

Replace a site's scheduled task.

אימות

שלחו מפתח 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`.

גוף הבקשה

שם	סוג	נדרש	מה זה
`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 s…
`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 forma…
`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 subsequ…

תשובה

שם	סוג	נדרש	מה זה
`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…
`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}