認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/reseller/services/{siteId} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The same row `listResellerServices` returns, for one site. A site outside your client subtree is a 404, never a 403 — so this is not an existence oracle. Requires `reseller.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | はい | — |
primary_domain | string | はい | — |
name | string | いいえ | — |
status | SiteStatus | はい | A site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t… |
product_line | object | いいえ | — |
plan_code | object | いいえ | — |
plan_name | object | いいえ | — |
held_by_reseller | boolean | いいえ | True when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals… |
pending_deletion_at | object | いいえ | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | いいえ | What YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N… |
sell_currency | object | いいえ | — |
created_at | string | はい | — |
disk_used_bytes | object | いいえ | Null when the hosting platform has no usage to report for this site. |
bandwidth_used_bytes | object | いいえ | Outbound bandwidth this billing period, or null. |
usage_measured_at | object | いいえ | When the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44). |
このエンドポイントが返すエラー
401 · 403 · 404 · 429