hosting

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

Replace a site's scheduled task.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran sites.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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> }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`siteId (path)`	`Uuid`	Ya	Site ID (UUIDv7).
`taskId (path)`	`string`	Ya	The task id returned by `listSiteScheduledTasks`.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`schedule`	`string`	Ya	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`	Ya	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`	Tidak	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`	Tidak	Whether the task runs. ⛔ Honoured by `updateSiteScheduledTask` and ignored by `createSiteScheduledTask` — a newly created task is always active, and pausing one is a subsequ…

Respons

Nama	Jenis	Diperlukan	Apakah ia
`id`	`string`	Ya	The task's identifier at the vendor, used to update or delete it.
`schedule`	`string`	Ya	The crontab expression, carried verbatim. A customer who typed `/15 * * *` sees exactly that back, never a normalised rewriting of it.
`command`	`string`	Ya	The command the vendor runs, as the site's own user.
`enabled`	`boolean`	Ya	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`	Ya	Where the task's output is mailed, or `""` when the vendor mails it nowhere.

Ralat yang boleh dikembalikan oleh titik akhir ini

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

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