security

PATCH `/v1/ip-allow/{entry_id}`

Change an entry.

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

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

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

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

Попробовать

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

curl -X PATCH https://api.zinndigital.com/v1/ip-allow/{entry_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "cidr": <string>, "label": <string> }'

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

Подробнее

Partial update. Disabling an entry (`enabled: false`) is the reversible way to narrow access during an incident - it keeps the range visible so you can see what you turned off, which a deletion does not.

Параметры

Имя	Тип	Обязательно	Что это
`entry_id (path)`	`string`	Да	—
`org_id (query)`	`string`	Нет	—

Тело запроса

Имя	Тип	Обязательно	Что это
`cidr`	`string`	Да	An address or a CIDR range. `0.0.0.0/0` and `::/0` are refused, as is anything broader than /8 (IPv4) or /32 (IPv6). Both families are checked - rejecting only the IPv4 literal…
`label`	`string`	Да	—
`expires_at`	`string`	Нет	—
`enabled`	`boolean`	Нет	—

Ответ

Имя	Тип	Обязательно	Что это
`id`	`string`	Да	—
`scope`	`string<staff_infra, staff_site, customer_site>`	Да	—
`cidr`	`string`	Да	Canonical CIDR. A bare address is stored as a host network (`/32`, or `/128` for IPv6) so one column answers both "is this a range" and "does it contain X".
`label`	`string`	Да	Required. An unlabelled range is one nobody dares remove, which is how a list grows until it stops being a control.
`expires_at`	`string`	Нет	null = permanent. An expired entry is NOT deleted - it stays visible and greyed so an operator can see what lapsed and re-add it.
`enabled`	`boolean`	Да	—
`expired`	`boolean`	Да	Computed server-side. Two surfaces deriving "is this still in force?" from a raw timestamp is two implementations of one decision, and they disagree on the boundary second.
`in_force`	`boolean`	Да	enabled AND not expired - the only field that decides anything.
`created_by`	`string`	Да	Audit ref of whoever added it (`user:<id>` / `apikey:<id>`).
`created_at`	`string`	Да	—

PATCH /v1/ip-allow/{entry_id}