hosting

POST `/v1/sites/{siteId}/scheduled-tasks`

Schedule a command on a site.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`siteId (path)`	`Uuid`	Igen	Site ID (UUIDv7).

Kérés törzse

Név	Típus	Kötelező	Mi ez
`schedule`	`string`	Igen	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`	Igen	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`	Nem	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`	Nem	Whether the task runs. ⛔ Honoured by `updateSiteScheduledTask` and ignored by `createSiteScheduledTask` — a newly created task is always active, and pausing one is a…

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	The task's identifier at the vendor, used to update or delete it.
`schedule`	`string`	Igen	The crontab expression, carried verbatim. A customer who typed `/15 * * *` sees exactly that back, never a normalised rewriting of it.
`command`	`string`	Igen	The command the vendor runs, as the site's own user.
`enabled`	`boolean`	Igen	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`	Igen	Where the task's output is mailed, or `""` when the vendor mails it nowhere.

Hibák, amelyeket ez a végpont visszaadhattatlan

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

POST /v1/sites/{siteId}/scheduled-tasks