hosting

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

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

hosting အားလုံးသော အဆုံးသတ်များ

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပို့ပါ။ သော့တွင် hosting.deploy.manage ခွင့်ပြုချက် ပါရှိရမည်ဖြစ်ပြီး၊ ၎င်းမပါရှိသော သော့ကို 404 အစား 403 ဖြင့် ငြင်းပယ်ပါမည်။

ဤ အမှတ်ဆက် (endpoint) သည် အဖွဲ့အစည်း အိုင်ဒီ (organisation id) ကို မယူပါ။ သင်၏ သော့ချက် (key) သည် ၎င်းပိုင်ဆိုင်သည့် အဖွဲ့အစည်းကို အလိုအလျောက် ဖော်ထုတ်ပြီးဖြစ်ကာ တုံ့ပြန်ချက်ကိုလည်း ၎င်းနှင့်သာ ကန့်သတ်ထားမည် ဖြစ်သည်။

စမ်းကြည့်ရန်

ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။

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 ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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).

တောင်းဆိုချက် ကိုယ်ထည်

နာမည်အမျိုးအစားလိုအပ်သည်ဘာလဲဆိုတာ
enabledbooleanဟုတ်ကဲ့
subdirstringမဟုတ်ပါ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_idstringဟုတ်ကဲ့
enabledbooleanဟုတ်ကဲ့Whether the customer has switched two-way sync on.
availablebooleanဟုတ်ကဲ့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_reasonstringမဟုတ်ပါA sentence the customer reads when `available` is false. Null when it is available.
subdirstringမဟုတ်ပါWhich directory of the site syncs. Empty means the whole document root.
statestring<idle, synced, conflict, adopt, error, unsupported>ဟုတ်ကဲ့`unsupported` is TERMINAL and is not a failure either: the site is served from its repository, so there are no separate files on our side to push back. It leaves the sweep's rot…
branchstringမဟုတ်ပါ
repositorystringမဟုတ်ပါ`owner/repo`, or null when no repository is connected.
conflict_commitstringမဟုတ်ပါ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_atstringမဟုတ်ပါ
last_sync_notestringမဟုတ်ပါ
runsSiteRepoSyncRun[]ဟုတ်ကဲ့The most recent runs, newest first. Includes the no-ops.

ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ

401 · 403 · 404 · 422 · 429