hosting
GET /v1/sites/{siteId}/transfer
Get this site's most recent transfer offer.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/transfer \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The latest offer for this site, in any state, so the site page can show either a pending handover or the outcome of the last one. `404` when the site has never been offered. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | いいえ | The site's name as it was when the offer was made. Snapshotted onto the offer, not read live: while a transfer is pending the site still belongs to the sender, and reading it li… |
primary_domain | string | いいえ | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<incoming, outgoing> | はい | From **this caller's** point of view. Computed per request, never stored — the same row is outgoing to one party and incoming to the other. |
status | string<pending, accepted, declined, cancelled, expired, failed> | はい | Five terminal states rather than one, because *why* an offer ended is what support is actually asked. `failed` means it was accepted and could not complete; nothing moved. |
include_domain | boolean | はい | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | いいえ | Only populated for the **sender**. To the receiver it is their own address and carries no information; to anyone else it would be a third party's email address in a row two orga… |
message | string | いいえ | — |
expires_at | string | はい | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | いいえ | — |
renewal_amount_minor | integer | いいえ | — |
renewal_currency | string | いいえ | — |
created_at | string | はい | — |
decided_at | string | いいえ | — |
failure_reason | string | いいえ | Why a `failed` transfer could not complete. Empty otherwise. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429