hosting

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

Schedule a command on a site.

การยืนยันตัวตน

ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ sites.view หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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 s…
`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 forma…
`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 subsequ…

การตอบกลับ

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`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…
`email_output`	`string`	ใช่	Where the task's output is mailed, or `""` when the vendor mails it nowhere.

ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้

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

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