Domain URL Whitelisting

1 min read

Admin PortalDay 0 Task🔒 Admin Only

Domain & URL Whitelisting #

To ensure reliable communication with approved external services, you must whitelist your domains in BuildPiper. This allows the platform to securely connect with all configured integrations and endpoints.

This is a Day 0 task — it must be completed during initial platform setup by the Platform Engineering team before any third-party integrations are used.

Day 0
Required Task
Admin
Access Only
2
Whitelist Fields
JSON
Format Input

Overview #

If the URL control whitelist field is left empty, authentication test requests via the server field to any external domain may be blocked by default — depending on the system’s overall security configuration.

To enable testing against specific third-party authentication servers, their domains must be added to this whitelist. The Platform team must add all third-party domains they want BuildPiper to access.

⚠️

Why This Matters

Without proper domain whitelisting, BuildPiper may fail to reach external services like JIRA, Slack, Git providers, or custom SSO endpoints — causing integration failures during pipeline execution.

Who Can Access #

🔒

Admin Portal Only

The Third Party Whitelisted Domains setting is accessible exclusively via the Admin Portal. A user must have Super Admin credentials to configure this setting. Regular users cannot view or edit this section.

How to Access / Navigate #

Navigation PathAccessing Third Party Whitelisted Domains
Login to BP

Bottom User Panel

System Settings

Third Party Whitelisted Domains

User Accessing Admin Panel — System Settings

Third Party Whitelisted Domains #

The System Settings → Third Party Whitelisted Domains section contains two fields. Both accept a JSON array of domain strings.

FieldsBP System Global Settings — Whitelist Configuration
Field 1URL Control WhitelistRequired

Controls which external domains BuildPiper is permitted to make outbound requests to — covering authentication tests, API calls, and webhook endpoints.

If left empty, outbound requests to external domains may be blocked by the system’s security configuration.
Field 2Version ControlRequired

Whitelists domains specifically for version control interactions — including Git repository hosts, SCM providers, and CI/CD webhook sources.

Third Party Whitelisted Domains — System Settings Screen

URL Format & Examples #

Both whitelist fields accept a JSON array of domain strings. Enter domains exactly as shown — no trailing slashes required.

JSONURL Control Whitelist — example value
["buildpiper.atlassian.net", "dev274336.service-now.com", "dev194357.service-now.com"]
JSONVersion Control — example value
["buildpiper.atlassian.net", "dev274336.service-now.com", "dev194357.service-now.com"]

💡 Common Domains to Whitelist
Ticketing
*.atlassian.net
*.service-now.com
Git Providers
github.com
gitlab.com
bitbucket.org
Notifications
slack.com
hooks.slack.com
Custom / Self-Hosted
your-gitlab.company.net
registry.company.net
After adding domains, click APPLY IMMEDIATELY or APPLY ASYNC to activate the whitelist without restarting the platform.

📘 BuildPiper Documentation · Domain & URL Whitelisting

Last updated: March 2026