hosting
POST /v1/sites/{siteId}/migrations/probe
Sign in to the old host and show what is there.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ hosting.import.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/probe \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source": <MigrationSource>, "host": <string>, "username": <string> }'เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
The migration form's preview: authenticates against the source and enumerates the estate **without creating a job**. Run while the customer is still on the screen, which is the whole design — a wrong password becomes a form error instead of a job that fails an hour later, and the customer confirms what is about to move before anything is committed. It is also where the mail precondition is discovered early enough to be fixable. Read `unavailable` before believing an empty list: it names what we could not look at, and "there is no mail here" and "this login cannot see mail" are opposite answers. Refusals arrive as 422 with a machine `code` per detail row (`source_credentials_rejected`, `source_unreachable`, `source_host_not_public`, `plesk_needs_admin_credentials`, `credential_required`), so the dashboard localises them rather than showing engine English. ⛔ `POST` although it creates nothing: the body carries a live credential for somebody else's server, and a `GET` would put it in a query string — browser history, proxy logs, access logs. Requires `hosting.import.manage`.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
siteId (path) | Uuid | ใช่ | Site ID (UUIDv7). |
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
source | MigrationSource | ใช่ | The kind of hosting the site is being pulled from. ⛔ `plesk` is offered so the refusal can be specific and actionable, **not** because it is supported: `pleskbackup` is reachabl… |
host | string | ใช่ | The server's public hostname, e.g. `server123.yourhost.com`. Must resolve to a public address — a private or link-local target is refused with `source_host_not_public` at the do… |
username | string | ใช่ | The login for the source panel or account. |
port | integer | ไม่ใช่ | `0` means the source driver's default for that panel. |
password | string | ไม่ใช่ | — |
private_key | string | ไม่ใช่ | An SSH private key in PEM form, for an `ssh` source. |
api_token | string | ไม่ใช่ | — |
include_mail | boolean | ไม่ใช่ | ⚖️ Defaults to true, and a source that cannot deliver mailboxes is **refused rather than silently migrated without them** — a migration that moves a website and loses the mail i… |
mailbox_passwords | object | ไม่ใช่ | `address -> password`, for every mailbox being moved. Required up front rather than discovered mid-sync: most panels will not hand over a mailbox without its own password, and f… |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
domains | string[] | ใช่ | — |
files | integer | ใช่ | How many files were found. A count, not the list — a 5,000-file estate is not a form field, and the per-item rows are written by the job. |
databases | MigrationSourceDatabase[] | ใช่ | — |
mailboxes | MigrationSourceMailbox[] | ใช่ | — |
total_bytes | integer | ใช่ | — |
truncated | boolean | ใช่ | True when the source stopped short of a complete listing. Reported, never swallowed. |
unavailable | object | ใช่ | ⭐ **The most important field here**: `capability -> machine code`, naming what we could not look at. An empty object means "we looked and there is nothing else", which is a diff… |
mailboxes_without_passwords | string[] | ใช่ | The addresses no usable password was supplied for. The form points at exactly these rows; a create with any of them present is refused with `mailbox_passwords_required`. |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 422 · 429