認証
ベアラー トークンとして API キーを送信します。キーには sites.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/databases \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Creates a database and its user, and returns the generated password **exactly once**. The password is generated by this platform rather than chosen by the caller, because it is a machine-to-machine credential that nobody types and a human-chosen one is the weakest link in a stack the customer cannot patch. It is not stored in our records, not logged, and cannot be read back by any endpoint — a customer who loses it creates another database. The effective ceiling is applied before the vendor is called: a package type that does not permit databases, and an allowance that is already spent, are both `422` with a sentence the customer can act on. A name the package already carries is `409`. The vendor prefixes names per package, so the returned `name` is rarely the name that was asked for and the client must show the returned value. `404` for a site with no vendor hosting package. Requires `sites.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
name | string | はい | The name to ask for. The server's own name is returned in `SiteHostingDatabase.name` and may differ; there is deliberately no password field here, because the platform generates… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
database | SiteHostingDatabase | はい | The created database, exactly as `listSiteDatabases` will report it. |
password | string | はい | The generated password, shown once. Deliberately carries no example — a documented example of a credential field is the shape people copy. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503