hosting
POST /v1/site-imports
Restore a site from a web archive, or migrate one in.
ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ
បញ្ជូនសោ API ជា bearer token។ សោនេះត្រូវតែមានសិទ្ធិ hosting.import.manage។ សោដែលគ្មានសិទ្ធិនេះនឹងត្រូវបដិសេធដោយកូដ 403 មិនមែន 404 ទេ។
កន្លែងដែលលេខសម្គាល់អង្គការរបស់អ្នកត្រូវដាក់
ចំនុចបញ្ចប់នេះទទួលយក org_id ជាវាលមួយនៅក្នុងតួ JSON។
លេខសម្គាល់អង្គការរបស់អ្នកស្ថិតនៅលើអេក្រង់គ្រាប់ចុច API ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក នៅជាប់នឹងគ្រាប់ចុចផ្ទាល់តែម្ដង។ វាគឺជាលេខសម្គាល់ដូចគ្នានៅក្នុងការហៅទូរសព្ទនីមួយៗដែលអ្នកធ្វើ។
សាកល្បង
ជំនួសអ្វីមួយនៅក្នុងសញ្ញាពងក្រពើ < > ដោយប្រើតម្លៃផ្ទាល់ខ្លួនរបស់អ្នក ហើយជំនួសកន្លែងរក្សាទុកសោដោយប្រើសោចេញពីផ្ទាំងគ្រប់គ្រងរបស់អ្នក។
curl -X POST https://api.zinndigital.com/v1/site-imports \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source": <SiteImportSource>, "output": <SiteImportOutput>, "source_domain": <string> }'បានចូលគណនីរួចហើយមែនទេ? កុងសូល API ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក បំពេញលេខសម្គាល់ស្ថាប័នពិតប្រាកដរបស់អ្នក និងសោផ្ទាល់ខ្លួនរបស់អ្នក ហើយដំណើរការសំណើទល់នឹង API ផ្ទាល់ ដូច្នេះអ្នកអាចមើលឃើញការឆ្លើយតបពិតប្រាកដ។ បើកចំណុចបញ្ចប់នេះក្នុងកុងសូល API
ព័ត៌មានលម្អិត
Starts a durable, resumable import workflow and returns the new job state, never a bare acknowledgement. A Wayback restore must name snapshot_day: the most recent capture of an expired domain is usually a parking page, so there is no safe default (422 without it). The output is either a static HTML document root or a WordPress import — both are supported and neither is a default. A site with an import already running returns 409. ⚠️ ownership_attested is recorded, not enforced: the platform's obligation here is to know who requested what. Requires hosting.import.manage.
ប៉ារ៉ាម៉ែត្រ
| ឈ្មោះ | ប្រភេទ | តម្រូវការ | តើវាជាអ្វី |
|---|---|---|---|
Idempotency-Key (header) | string | ទេ | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
សំណើរបស់រាងកាយ
| ឈ្មោះ | ប្រភេទ | តម្រូវការ | តើវាជាអ្វី |
|---|---|---|---|
org_id | Uuid | ទេ | Which organisation this import belongs to. Only needed by an account that acts for more than one and is not naming a site_id — when a site is named, the site decides,… |
source | SiteImportSource | បាទ/ចាស | Where the content comes from. ⛔ Deliberately not the same enum as a site's source: that one records what a site was built from, for ever, while this selects a fetch strategy and… |
output | SiteImportOutput | បាទ/ចាស | What the import produces. Both are supported; neither is a default. |
source_domain | string | បាទ/ចាស | The domain whose archive to restore, or — for archive_url — the URL of the archive to migrate in. |
target_domain | string | ទេ | The domain the result is served on. Defaults to source_domain. |
site_id | Uuid | ទេ | Restore into an existing site. Omit to produce a bundle and choose the target later. |
snapshot_day | string | ទេ | Which day's snapshot to restore. Required for wayback — the most recent capture of an expired domain is usually a parking page, so there is no safe default. |
crawl_depth | integer | ទេ | — |
request_budget | integer | ទេ | The hard ceiling on requests this job may make against the source. Bounded per job so one 400,000-capture domain cannot consume the platform's whole archive allowance. |
ownership_attested | boolean | ទេ | ⚠️ The customer's assertion that they control the domain, recorded because it cannot be reconstructed afterwards. It is not a legal control and is not presented as one. |
ផ្អាកដំណើរការ
| ឈ្មោះ | ប្រភេទ | តម្រូវការ | តើវាជាអ្វី |
|---|---|---|---|
id | Uuid | បាទ/ចាស | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | ទេ | The site this import lands on, or empty. Empty is a real outcome, not an error: an aged-domain restore produces a downloadable bundle and the customer picks the target afterwards. |
source | SiteImportSource | បាទ/ចាស | Where the content comes from. ⛔ Deliberately not the same enum as a site's source: that one records what a site was built from, for ever, while this selects a fetch strategy and… |
output | SiteImportOutput | បាទ/ចាស | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | បាទ/ចាស | fetching and building are separate states rather than one running because they fail for opposite reasons and the customer's next action differs — a stall in fetching is… |
status_reason | string | ទេ | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could not be shown to the other 57 locales. |
source_domain | string | បាទ/ចាស | — |
target_domain | string | ទេ | — |
snapshot_day | string | ទេ | — |
crawl_depth | integer | ទេ | — |
urls_total | integer | បាទ/ចាស | — |
urls_done | integer | បាទ/ចាស | — |
urls_failed | integer | បាទ/ចាស | — |
detected_platform | string | ទេ | What the archived site was built on, once the crawl has seen a page — the same codes as ArchivePlatform.platform. ⛔ Empty means not established, never plain HTML; the two… |
pre_restore_backup_id | string | ទេ | The safety backup taken of the target site immediately before this restore overwrote it. ⚖️ Owner ruling 2026-09-08: a restore onto a site that already has content is gated behind… |
progress_percent | integer | បាទ/ចាស | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say which step. |
requests_spent | integer | បាទ/ចាស | — |
request_budget | integer | បាទ/ចាស | — |
budget_exhausted | boolean | បាទ/ចាស | True when the job stopped because it ran out of requests. Surfaced deliberately — it otherwise looks identical to a job that finished, and the customer's next action depends on… |
bundle_bytes | integer | ទេ | — |
created_at | string | បាទ/ចាស | — |
started_at | string | ទេ | — |
finished_at | string | ទេ | — |
can_cancel | boolean | បាទ/ចាស | — |
កំហុសដែលចំណុចបញ្ចប់នេះអាចបង្វិលត្រឡប់មកវិញ
401 · 403 · 404 · 409 · 422 · 429 · 503