Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/ip-allow \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | The 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
entries | IpAllowEntry[] | Yes | — |
restricted | boolean | Yes | false = your sites are reachable from any address. An empty list is NOT a deny-all. |
staff_ranges | integer | Yes | How many Zinn® support ranges are unioned in. |