security

PATCH /v1/ip-allow/{entry_id}

Change an entry.

Všechny koncové body security

Všechny dokumenty pro vývojáře

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
entry_id (path)stringAno
org_id (query)stringNe

Tělo požadavku

NázevTypPožadovánoCo to je
cidrstringAnoAn 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 is…
labelstringAno
expires_atstringNe
enabledbooleanNe

Odpověď

NázevTypPožadovánoCo to je
idstringAno
scopestring<staff_infra, staff_site, customer_site>Ano
cidrstringAnoCanonical 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".
labelstringAnoRequired. An unlabelled range is one nobody dares remove, which is how a list grows until it stops being a control.
expires_atstringNenull = permanent. An expired entry is NOT deleted - it stays visible and greyed so an operator can see what lapsed and re-add it.
enabledbooleanAno
expiredbooleanAnoComputed 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_forcebooleanAnoenabled AND not expired - the only field that decides anything.
created_bystringAnoAudit ref of whoever added it (user:<id> / apikey:<id>).
created_atstringAno