hosting

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

Replace a site's scheduled task.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը 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}