IP Whitelisting

Overview

The HVOne Dashboard allows clients to securely manage access to sensitive APIs through self-service IP whitelisting. By restricting access to known IP addresses or IP ranges, this feature helps ensure that only trusted networks can interact with the APIs.

This guide explains how to configure and manage IP whitelisting for:

• Output/Logs API (Results API)
• Authentication API (CPR Auth API)

Prerequisites

Before using IP whitelisting, ensure the following:

• You have access to the HVOne Dashboard.
• You are assigned to at least one production Business Unit (BU).
• You have the required permissions to manage API access.

Purpose & use case

Who is this for?

• Clients
• SA/IE teams
• Support teams
• KAM / Sales teams

When should this be used? When restricting API access to known networks.

Step-by-step guide

1. Setting up

1. Log in to the HVOne Dashboard.
2. Navigate to DevHub.
3. Click on Configurations.
4. Click on IP Whitelisting.
5. Choose the API you want to configure:
   • Output/Logs API
   • Authentication API

Each has its own section for managing whitelisted IPs.

TODO

Screenshots: DevHub tab, Configurations menu, IP Whitelisting option, and the API selector. (Pending migration from Notion.)

2. How it works

1. Click ➕ Add IP Address.
2. A modal popup appears.
3. Enter the IP or CIDR block:
   • Single IP → 203.0.113.42
   • CIDR range → 203.0.113.0/24
4. Select the Business Unit (BU):
   • Only production BUs are eligible.
   • The dropdown shows only the prod BUs you have access to.

TODO

Screenshots: Add IP Address button, IP/CIDR input modal, BU dropdown. (Pending migration from Notion.)

3. Common issues & fixes

Issue	Cause	Fix
"Invalid IP format"	IP entered is not valid.	Enter a correct IPv4 address or CIDR block (e.g., 192.168.1.10 or 192.168.1.0/24).
BU not visible in dropdown	User has no access to prod BU.	Request access to the required production BU.
IP not taking effect	Cached connections still active.	Wait a few minutes or retry API requests from whitelisted IPs.

Deep dive

Core concepts

• IP whitelisting restricts API access to specified IPs or ranges.
• Ensures only trusted networks interact with HVOne APIs.

Technical details & workflows

• Validation only accepts IPv4 and CIDR ranges.
• Applies per API (Output/Logs API and Authentication API separately).
• Whitelists are tied to production Business Units only.

FAQs

Q: Can I whitelist multiple IPs at once? A: Currently, IPs must be added one at a time.

Q: Can non-prod BUs use IP whitelisting? A: No, the feature is only available for production BUs.

Q: Can I whitelist IPv6 addresses? A: Not supported at the moment — only IPv4 and CIDR ranges are accepted.

Q: How quickly does whitelisting take effect? A: Changes usually apply within 15 minutes.

Q: How do I whitelist IPs for the staging environment? A: We do not have any restriction for the staging environment, so IP whitelisting is not required.