hosting

POST /v1/sites/{siteId}/databases

Create a database on a site.

Все эндпоинты hosting

Вся документация для разработчиков

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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.view and sites.panel_access.

Параметры

ИмяТипОбязательноЧто это
siteId (path)UuidДаSite ID (UUIDv7).

Тело запроса

ИмяТипОбязательноЧто это
namestringДа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…

Ответ

ИмяТипОбязательноЧто это
databaseSiteHostingDatabaseДаThe created database, exactly as listSiteDatabases will report it.
passwordstringДа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