databases
POST /v1/databases/{databaseId}/credentials
Reveal the database password.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/databases/{databaseId}/credentials \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Gated on databases.credentials.reveal — its own permission, held by no read-only role, because this is the one call that moves a secret opening every row the customer has. Every call is audit-logged. ⛔ A POST rather than a GET on purpose. A GET would put the credential in browser history, proxy logs and Referer headers.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
databaseId (path) | string | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
username | string | はい | — |
password | string | はい | — |
host | string | はい | — |
port | integer | はい | — |
database_name | string | はい | — |
engine | string<postgres, mysql> | はい | — |
dsn | string | はい | A ready-to-use connection string for this database's engine — postgresql://…?sslmode=verify-full or mysql://…?ssl-mode=VERIFY_IDENTITY. Both spellings authenticate the… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422