databases
POST /v1/databases/{databaseId}/credentials
Reveal the database password.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/databases/{databaseId}/credentials \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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 s… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422