hosting
POST /v1/sites/{siteId}/scheduled-tasks
Schedule a command on a site.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/scheduled-tasks \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "schedule": <string>, "command": <string> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
Adds one cron job. The schedule and the command are validated before the vendor is called: a five- or six-field crontab expression, no newline anywhere (a crontab is lines, so one embedded newline is a second job the customer never wrote), and a command within the length the vendor's crond accepts. Each refusal is a 422 carrying our sentence and naming the fix. ⛔ enabled is accepted for symmetry with updateSiteScheduledTask and ignored here — a newly created task is always active. Pause it with a subsequent updateSiteScheduledTask carrying the whole row. 404 for a site with no managed hosting package. Requires sites.view and sites.panel_access.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
siteId (path) | Uuid | Tak | Site ID (UUIDv7). |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
schedule | string | Tak | 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 | Tak | 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 | Nie | 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 | Nie | Whether the task runs. ⛔ Honoured by updateSiteScheduledTask and ignored by createSiteScheduledTask — a newly created task is always active, and pausing one is a… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | string | Tak | The task's identifier at the vendor, used to update or delete it. |
schedule | string | Tak | The crontab expression, carried verbatim. A customer who typed */15 * * * * sees exactly that back, never a normalised rewriting of it. |
command | string | Tak | The command the vendor runs, as the site's own user. |
enabled | boolean | Tak | 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 | Tak | Where the task's output is mailed, or "" when the vendor mails it nowhere. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 409 · 422 · 429 · 503