hosting

PUT `/v1/sites/{siteId}/repo/sync`

Turn two-way sync on or off for a site.

ການພິສູດຕົວຕົນ

ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ hosting.deploy.manage; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.

ຈຸດເຊື່ອມຕໍ່ນີ້ບໍ່ໄດ້ຮັບ ID ອົງກອນ. ລະຫັດຂອງທ່ານໄດ້ລະບຸອົງກອນທີ່ມັນຂຶ້ນກັບແລ້ວ, ແລະ ຄໍາຕອບແມ່ນຖືກຈໍາກັດຂອບເຂດໄວ້ສໍາລັບອົງກອນນັ້ນ.

ລອງໃຊ້ເບິ່ງ

ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/repo/sync \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": <boolean> }'

ເຂົ້າສູ່ລະບົບແລ້ວບໍ? ໂຄງສົນທະນາ API ໃນໜ້າັດສະຫຼອງຂອງທ່ານຈະຕື່ມຂໍ້ມູນລະຫັດອົງກອນຕົວຈິງ ແລະ ລະຫັດລັບສ່ວນຕົວຂອງທ່ານໂດຍອັດຕະໂນມັດ, ແລະ ປະຕິບັດການຮ້ອງຂໍຜ່ານ API ຕົວຈິງ ເພື່ອໃຫ້ທ່ານສາມາດເຫັນຜົນຕອບຮັບທີ່ແທ້ຈິງໄດ້. ເປີດຈຸດສິ້ນສຸດນີ້ໃນຄອນໂສລ API

ລາຍລະອຽດ

Free, and refused with 422 unless the customer has connected their own GitHub account. Turning it on does not push anything by itself — the first run is either the scheduled sweep or an explicit run. Requires `hosting.deploy.manage`.

ພາຣາມິເຕີ

ຊື່	ປະເພດ	ຕ້ອງການ	ສິ່ງທີ່ມັນເປັນ
`siteId (path)`	`Uuid`	ແມ່ນແລ້ວ	Site ID (UUIDv7).

ເນື້ອຫາຂອງຄຳຮ້ອງ

ຊື່	ປະເພດ	ຕ້ອງການ	ສິ່ງທີ່ມັນເປັນ
`enabled`	`boolean`	ແມ່ນແລ້ວ	—
`subdir`	`string`	ບໍ່	Restrict the sync to one directory of the site. Empty syncs the whole document root, which for a WordPress site is usually not what the customer wants.

ຖືກໂຈະ

ຊື່	ປະເພດ	ຕ້ອງການ	ສິ່ງທີ່ມັນເປັນ
`site_id`	`string`	ແມ່ນແລ້ວ	—
`enabled`	`boolean`	ແມ່ນແລ້ວ	Whether the customer has switched two-way sync on.
`available`	`boolean`	ແມ່ນແລ້ວ	Whether it is permitted at all — true only once the customer has connected their OWN git account. False here makes `enabled` irrelevant; the engine will not sync either way.
`unavailable_reason`	`string`	ບໍ່	A sentence the customer reads when `available` is false. Null when it is available.
`subdir`	`string`	ບໍ່	Which directory of the site syncs. Empty means the whole document root.
`state`	`string<idle, synced, conflict, adopt, error>`	ແມ່ນແລ້ວ	`conflict` and `adopt` are HELD, not failed — the sync stopped on purpose and is waiting for the customer to choose a side.
`branch`	`string`	ບໍ່	—
`repository`	`string`	ບໍ່	`owner/repo`, or null when no repository is connected.
`conflict_commit`	`string`	ບໍ່	The commit in the repository that we have not seen — the one the customer needs to look at before choosing. Null unless held.
`last_sync_at`	`string`	ບໍ່	—
`last_sync_note`	`string`	ບໍ່	—
`runs`	`SiteRepoSyncRun[]`	ແມ່ນແລ້ວ	The most recent runs, newest first. Includes the no-ops.

ຂໍ້ຜິດພາດທີ່ຈຸດເຊື່ອມຕໍ່ນີ້ສາມາດສົ່ງຄືນໄດ້

401 · 403 · 404 · 422 · 429

PUT /v1/sites/{siteId}/repo/sync