hosting

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

Replace a site's scheduled task.

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

Naam	Type	Verplicht	Wat dit is
`siteId (path)`	`Uuid`	Ja	Site ID (UUIDv7).
`taskId (path)`	`string`	Ja	The task id returned by `listSiteScheduledTasks`.

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`schedule`	`string`	Ja	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`	Ja	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`	Nee	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`	Nee	Whether the task runs. ⛔ Honoured by `updateSiteScheduledTask` and ignored by `createSiteScheduledTask` — a newly created task is always active, and pausing one is a subsequ…

Reactie

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

Fouten die dit eindpunt kan retourneren

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

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