security

GET /v1/ip-allow

Which addresses may open a shell on your sites.

Alle security Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/ip-allow \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Your organisation's SSH/SFTP allow-list (#1493). While it is EMPTY your sites are reachable from anywhere; adding the first entry is what turns the restriction on. `restricted` says which of those two states you are in, in so many words. A client that inferred it from an empty array would be guessing at the difference between "open to the whole internet" and "locked down", which are opposite facts. `staff_ranges` is a COUNT, not the addresses. Zinn® support and provisioning are unioned into the effective list so a narrow entry of yours cannot lock us out of the site you have just called us about - but our infrastructure's ranges are not published to tenants.

Parameter

NameTypErforderlichWas es ist
org_id (query)stringNeinThe organization to act on. Omitted (or empty) means your own. A reseller managing a client org must name it - defaulting silently would edit the reseller's own list while the s…

Antwort

NameTypErforderlichWas es ist
entriesIpAllowEntry[]Ja
restrictedbooleanJafalse = your sites are reachable from any address. An empty list is NOT a deny-all.
staff_rangesintegerJaHow many Zinn® support ranges are unioned in.