What it does
An IP allowlist limits a client ID to the public IP addresses or ranges your servers call from. A call with that client ID's token from any other address is refused with 403, before it reaches any vault. A client ID without an allowlist accepts calls from any address, which is the default.
Each client ID has its own list. The list applies to every API version and in every region, including EU data residency, and a change takes effect within seconds. The allowlist is included on every plan, Lite included.
Setting it in the developer portal
- Sign in to the developer portal. The dashboard shows each client ID with an IP Allowlist field.
- Enter the addresses, separated by commas: single addresses such as
198.51.100.7or ranges in CIDR notation such as198.51.100.0/28. IPv6 is accepted too. The addresses on this page are documentation examples, which the portal refuses: use your own servers' public addresses. Under the field the portal shows the address you are signed in from, in case your servers share it. - Choose Save allowlist and confirm. To go back to any address, choose Allow any address.
The account owner and Developer members can change a list; Billing members can see it. Every change is recorded with who made it, and the owner gets an email with the list before and after.
What the portal accepts
- Up to 25 entries per client ID. Combine neighbouring addresses into a range if you need more.
- Public addresses only. Private, loopback, link-local, carrier-grade NAT, multicast and documentation ranges (such as
10.0.0.0/8or192.168.0.0/16) are refused, because calls reach us from your public NAT or egress address, never from those. - A range must be written from its first address:
198.51.100.5/24is refused with a suggestion of198.51.100.0/24. - Each part of an IPv4 address is a plain decimal number. A leading zero is refused, because some software reads
054as octal. - A list that covers every address (
/0) is refused; leave the list empty instead.
Refused calls
A call from an address outside the list gets 403 with the message Request origin is not in the allowed network list. Nothing is stored, read or forwarded. The address that counts is the one the connection reaches us from, after your own proxies, load balancers and NAT, so check your outbound address before you save a list. When you change hosting or add a server, add its address first and save, then move the traffic.
If you call the API through the card proxy
Some integrations send a request through the Card Vault proxy to the Enigma Vault API itself, for example to copy a card into Data Vault. That call reaches the API from the proxy's addresses, not yours. If the target client ID has an allowlist, add the proxy's addresses to it:
- United States (api.enigmavault.io):
18.210.171.115and44.196.108.239 - EU data residency (api-eu.enigmavault.io):
18.200.188.77and63.35.37.99
The same addresses are the ones to give a payment provider that allowlists the calls our proxy sends on your behalf.
Things to know
- Inbound proxy. While a client ID has an allowlist, its inbound proxy refuses partner calls and format changes, because partners call from their own addresses. Leave the allowlist off a client ID that receives inbound proxy calls.
- Hosted forms on API versions 1.0 to 1.6. On those versions the end user's browser submits the hosted form with the client ID, so its address is checked against the list. A client ID that uses hosted forms on those versions can't have an allowlist; version 1.7 and later are not affected.
- Getting a token from the token endpoint is not affected: the check applies to vault calls made with the token.
See also pricing and plan limits and the API reference. Questions: support@enigmavault.io.