hosting
POST /v1/sites/{siteId}/scheduled-tasks
Schedule a command on a site.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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> }'로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
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.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
siteId (path) | Uuid | 예 | Site ID (UUIDv7). |
요청 본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
schedule | string | 예 | 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 | 예 | 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 | 아니요 | 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 | 아니요 | Whether the task runs. ⛔ Honoured by updateSiteScheduledTask and ignored by createSiteScheduledTask — a newly created task is always active, and pausing one is a… |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
id | string | 예 | The task's identifier at the vendor, used to update or delete it. |
schedule | string | 예 | The crontab expression, carried verbatim. A customer who typed */15 * * * * sees exactly that back, never a normalised rewriting of it. |
command | string | 예 | The command the vendor runs, as the site's own user. |
enabled | boolean | 예 | 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 | 예 | Where the task's output is mailed, or "" when the vendor mails it nowhere. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404 · 409 · 422 · 429 · 503