partner
POST /v1/partner/customers/{externalId}/site-moves/{moveId}/cancel
Abandon a move that has not gone live, and give the slot back.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/partner/customers/{externalId}/site-moves/{moveId}/cancel \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Stops the move and removes the site it built on our hosting at once — it never served the customer's domain, so there is nothing to keep — which frees the slot. A move that replaced an empty site leaves that site where it is. A live move cannot be cancelled (422 move_is_live); a failed or cancelled one is returned unchanged, except that a failed move's half-built site is removed the same way. Requires partner.domains.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
externalId (path) | string | Да | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
moveId (path) | string | Да | The move's id, as createPartnerSiteMove returned it. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
status | string<queued, importing, imported, going_live, live, failed, cancelled> | Да | imported — built and answering on preview_url; switch DNS, then call goLivePartnerSiteMove. live — the domain is served by us over HTTPS; only now delete the original. |
domain | string | Да | — |
app | string | Да | — |
subscription_id | string | Да | — |
v2_site_id | object | Да | Our site id, once the site exists. |
source_ref | string | Да | — |
replaced_site | boolean | Да | Whether the move imported into an existing empty site. |
preview_url | string | Да | An https address that serves the imported site with no DNS change, or "" until imported. |
origin | object | Да | What the domain's web record must point at. Publish an A to each a address; aaaa is empty while the box has no IPv6 — publish no AAAA then. |
tls | object | Да | — |
checks | object | Да | What we measured on the preview after the import. |
error_code | string | Да | — |
error | string | Да | — |
created_at | string | Да | — |
updated_at | string | Да | — |
live_at | object | Да | — |
step | string<queued, creating_site, waiting_for_space, downloading, importing_files, importing_database, checking, ready_to_switch, waiting_for_dns, switching, securing, live, failed, cancelled> | Не | Where the move is, finer than status — show it with progress and elapsed_seconds so a long import never looks crashed. There is no size limit and no clock on a move's size… |
progress | object | Не | Measured on the hosting box while it applies the archive. null means not known yet — never zero. |
started_at | string | Не | — |
step_started_at | object | Не | — |
elapsed_seconds | integer | Не | — |
retryable | boolean | Не | — |
dns_case | string<partner_switch, customer_switch, unknown> | Не | — |
dns_holder | string | Не | — |
switch | object | Не | EXACTLY what to publish for the domain to be served by us. |
rollback_advised | boolean | Не | Your switch did not take within the attempt: restore the records you saved in dns.current. The original never stopped serving. |
waiting_since | object | Не | — |
reminders_sent | integer | Не | — |
extra_disk_mb | integer | Не | Free disk space (MB) this move gave the site on top of its plan so the move could land whatever its size (D28455). 0 when the plan's own space was enough. Always present. |
extra_disk_expires_at | object | Не | When extra_disk_mb ends: 7 days after live_at (D28457). null while the move is still running (the extra is open-ended until it goes live) or when there is no extra.… |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429