databases

POST /v1/databases/{databaseId}/allowed-ips

Permit a source address or range to connect.

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

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

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

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

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

Попробовать

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

curl -X POST https://api.zinndigital.com/v1/databases/{databaseId}/allowed-ips \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "cidr": <string>, "description": <string> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Gated on databases.manage. A bare address is normalised to a /32 or /128. Refused with 422 for an address inside our own cluster network (which would let any pod — including another tenant's database — reach this one), for an unparseable value, for a missing description, and for 0.0.0.0/0 unless acknowledge_public is true.

Параметры

ИмяТипОбязательноЧто это
databaseId (path)stringДа

Тело запроса

ИмяТипОбязательноЧто это
cidrstringДаAn address or CIDR range. A bare address is normalised to /32 or /128.
descriptionstringДаRequired. An allow-list nobody can explain is one nobody dares prune later.
acknowledge_publicbooleanНетRequired to add 0.0.0.0/0. Opening a database to the whole internet is allowed but must never happen by pasting a value somebody half understood.

Ответ

ИмяТипОбязательноЧто это
idstringДа
cidrstringДа
descriptionstringДа
created_atstringНет

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422