hosting
GET /v1/sites/{siteId}/ftp-users
List a site's FTP accounts.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ftp-users \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The FTP accounts on the site's hosting package, including the package's own primary account so the customer can see it exists. No password is returned for any of them, and none can be read back: the vendor does expose the primary account's live credentials in cleartext, and this platform deliberately never calls that endpoint. limit is the effective ceiling — the lower of what the package permits and what the customer bought, with either side being unlimited yielding to the other. permitted and can_create are separate because the screen says different things: "your plan does not include this" is not "you have used all of them". 404 for a site with no vendor hosting package. Requires sites.view.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteFtpUser[] | はい | The accounts on the package, the primary one first. |
limit | VendorAllowance | はい | The effective ceiling on FTP accounts for this site. |
permitted | boolean | はい | Whether the package type includes FTP at all. This is the flag behind "your plan does not include this". |
can_create | boolean | はい | permitted, and the effective ceiling has room. This is the flag behind "you have used all of them". Two fields rather than one because those are different sentences, and a… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503