For the complete documentation index, see llms.txt. This page is also available as Markdown.

IP Address Allow List to Access Resource API

You can now control exactly which IP addresses are allowed to access your Resource APIs. IP Whitelisting lets you grant, restrict, or revoke access to your Resources, giving you an added layer of protection over your data.

Why use IP Whitelisting

Your Resource API Key controls access to your Resources. If that key is ever exposed or compromised, anyone who has it could attempt to access your Resources.

IP Whitelisting closes that gap. When it's enabled, a request is only accepted if it comes from an IP address you've added to your allow list. Any request from an address that isn't on the list is blocked, even if it's using a valid API key. In short: a leaked key alone isn't enough to reach your Resources.

Enabling the feature

IP Whitelisting is turned off by default. To turn it on, contact the Support team and request that IP Whitelisting be enabled for your account.

Once Support has enabled it, you'll be able to manage your allow list directly from your dashboard.

Adding an IP address or range

After the feature is enabled, you can control access from your dashboard:

  1. Go to Settings → API Keys.

  2. Find the Resource API Key IP Allow List section.

  3. Click Add New IP.

  4. Enter the IP address or range you want to allow, then save.

You can add:

  • A single IPv4 address

  • A single IPv6 address

  • An IP range

You can add up to 100 records in total.

Only addresses on this list will be able to access your Resource APIs. Any request from an address not on the list will be denied.

Revoking access

To remove access for an IP address or range, go to the same Resource API Key IP Allow List section under Settings → API Keys, find the entry you want to remove, and click the delete button next to it. Access is deleted as soon as the entry is removed.

A few things to keep in mind

  • Make sure every server or endpoint that legitimately needs to reach your Resource APIs is included on the allow list before you rely on the feature, otherwise those requests will be blocked.

  • If your infrastructure uses dynamic IP addresses, add the appropriate range rather than a single address so valid requests aren't unexpectedly denied.

  • Review your allow list periodically and revoke any addresses that no longer need access.

Need help?

If you'd like IP Whitelisting enabled, or have questions about setting up your allow list, reach out to the Support team.

Last updated

Was this helpful?