hosting

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

Replace a site's scheduled task.

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).
taskId (path)stringAnoThe task id returned by listSiteScheduledTasks.

Tělo požadavku

NázevTypPožadovánoCo to je
schedulestringAnoA 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…
commandstringAnoThe command to run. Capped at the length the vendor's crond accepts — anything longer belongs in a script file the task then schedules.
email_outputstringNeWhere 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…
enabledbooleanNeWhether the task runs. ⛔ Honoured by updateSiteScheduledTask and ignored by createSiteScheduledTask — a newly created task is always active, and pausing one is a…

Odpověď

NázevTypPožadovánoCo to je
idstringAnoThe task's identifier at the vendor, used to update or delete it.
schedulestringAnoThe crontab expression, carried verbatim. A customer who typed */15 * * * * sees exactly that back, never a normalised rewriting of it.
commandstringAnoThe command the vendor runs, as the site's own user.
enabledbooleanAnoWhether 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_outputstringAnoWhere the task's output is mailed, or "" when the vendor mails it nowhere.

Chyby, které může tento koncový bod vrátit

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