This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

When you create a developer portal, by default you are provided with an Apigeesample domain name for accessing your live portal in the following format:

https://orgname-portalname.apigee.io

Whereorgname is the organization name andportalname is defined using the portal name converted to alllowercase and with spaces and dashes removed.

Before launching a developer portal, it is recommended that you provide your owncustom domain name. For example, a popular alternative is:

https://developers.example.com

For considerations for using a custom domain with a SAML identity provider, seeUsing a custom domain with the SAML identity provider.

Steps to customize your domain

To customize your domain name perform the following steps:

1. Register your domain name.
2. Create a TLS certificate for your custom domain.You will need the cert when creating the load balancer.
3. Determine the default hostname for your portal.
4. Create an Internet network endpoint group (NEG) to define the backend endpoint to your integrated portal for the load balancer.
5. Create a load balancer that points to the Internet NEG and reserves the IP for your incoming client requests.
6. Configure the custom domain on your portal.
7. Update your DNS to create a new record for the custom domain host.

Step 1: Register your domain name

If you need to register a new domain, there are many popular domain registrationsites available, such asGoogle Domains. Which domain registration site you choose is up to you.

When deciding on your domain name, consider that user-friendly, human-readableURLs are a key component in improving search engine optimization, as describedinImplement search engine optimization (SEO).

Step 2: Create a TLS certificate for your custom domain

Create a TLS certificate for your custom domain using your preferred tool, such asLet's Encrypt. For more information, see:

• SSL certificates overview
• Using self-managed SSL certificates

Step 3: Determine the default hostname for your portal

To determine the default hostname for your portal:

1. Display the list of portals.

   In the Apigee in Cloud console, go to theDistribution > Portals page.

   Go to Portals

2. Copy the contents in theLocation field for the portal for which youwant to create a custom domain. For example,apigee-gcp-prod1-helloworld.apigee.io.

   You will need this value in the next step.

Step 4: Create an Internet NEG

In this step you create an Internet network endpoint group (NEG) to define the backend endpoint to your integrated portal for the load balancer. For more information, seeInternet network endpoint groups overview.

1. In the Google Cloud console, go to theDashboard page and select or create a Google Cloud project.

   Go to the Dashboard page

2. SelectCompute Engine > Network endpoint groups in the navigator.

3. ClickCreate network endpoint group.

4. Configure the following fields:

   Field	Value
   Name	Enter a name for the Internet NEG.
   Network endpoint group type	SelectNetwork endpoint group (Internet).
   New network endpoint	Add through: SelectFully qualified domain name and port. Fully qualifed domain name: Enter the default domain name that you copied inStep 3: Determine the default hostname for your portal.

5. You can leave the remaining fields set to their defaults.

6. ClickCreate.

The Internet NEG is created.

Step 5: Create a load balancer

Create a load balancer that points to the Internet NEG and reserves the IP for your incoming client requests.

Select the load balancer type

1. In the Google Cloud console, go to theLoad balancing page.

   Go to Load balancing

2. ClickCreate load balancer.
3. ForType of load balancer, selectApplication Load Balancer (HTTP/HTTPS) and clickNext.
4. ForPublic facing or internal, selectPublic facing (external) and clickNext.
5. ForGlobal or single region deployment, selectBest for global workloads and clickNext.
6. ForLoad balancer generation, selectGlobal external Application Load Balancer and clickNext.
7. ClickConfigure.

Configure the load balancer

1. Click each category and configure the load balancer as described in the following table.

   Category	Steps
   Frontend configuration	Reserve the IP address for your incoming client requests and upload the TLS certificate created inStep 2: Create a TLS certificate: In theCreate global external Application Load Balancer section, position your cursor overFrontend configuration and click the arrow. Enter a name for the frontend in theName field. SelectHTTPS from theProtocol drop-down menu. In theIP address drop-down menu, selectCreate IP address The Reserve a new static IP address dialog displays. Enter a name for the static IP address in theName field. Optionally enter a description. ClickReserve. Store the IP address that has been reserved for use when setting up the DNS record. SelectCreate a new certificate in theCertificate drop-down. The Create a new certificate window slides open. Enter a name for the new certificate in theName field. SelectUpload my certificate underCreate mode. Upload your TLS certificate details, including the public key, certificate chain, and private key. ClickCreate. ClickDone to create the new frontend IP and port.
   Backend configuration	Configure the backend configuration to direct incoming traffic to the Internet NEG created inStep 4: Create an Internet network endpoint group (NEG): In theCreate global external Application Load Balancer section, position your cursor overBackend configuration and click the arrow. In theBackend services & backend buckets section, selectBackend services > Create a backend service from the drop-down. The Create backend service window slides open. Enter a name in theName field. SelectInternet network endpoint group in theBackend type drop-down. SelectHTTPS as the protocol. In theNew backend section, select the Internet NEG that you created inStep 4: Create an Internet network endpoint group (NEG) in theInternet network endpoint group drop-down menu, and clickDone. Clear the checkbox forEnable Cloud CDN. You can leave all other values set to their defaults. ClickCreate. Note: Cloud CDN is not supported for use with the Apigee Portal.
   Host and path rules	Configure the host and path rules to determine how your traffic will be directed: In theCreate global external Application Load Balancer section, position your cursor overHost and path rules and click the arrow. ClickAdvanced host and path rule (URL redirect, URL rewrite) underMode. In theNew host and path rule section: SelectRoute traffic to a single backend in theAction drop-down. ExpandAdd-on action (URL rewrite). Enter the default domain name that you copied inStep 3: Determine the default hostname for your portal in theHost rewrite field. Select the backend service that you configured in theBackend drop-down. ClickDone.

2. ClickCreate on theCreate global external Application Load Balancer page.

Step 6: Configure the custom domain on your portal

To configure the custom domain on your portal:

1. Display the list of portals.

   In the Apigee in Cloud console, go to theDistribution > Portals page.

   Go to Portals

2. Select your portal in the list.

3. SelectSettings.

4. Click theDomains tab.

5. Enter your custom domain name in theDomain field.

6. ClickEnable.

Test that when you access the custom domain in a browser you are directed to your integrated portal.

See alsoEditing a custom domain andDisabling a custom domain.

Step 7: Update your DNS

In your DNS system, create a new record for the custom domain host.

To create a Cloud DNS zone, follow the steps described inManaging Zones. Ensure that you configure the following fields:

After you create a zone, on the Zone details page, clickAdd record set and follow the steps described inManaging Records. Ensure that you configure the following fields:

Editing a custom domain on your portal

To edit a custom domain on your portal:

1. Display the list of portals.

   In the Apigee in Cloud console, go to theDistribution > Portals page.

   Go to Portals

2. Select your portal in the list.

3. SelectSettings.

4. Click theDomains tab.

5. Edit the custom domain information.

6. ClickSave.

Disabling a custom domain on your portal

To disable a custom domain name on your portal:

1. Display the list of portals.

   In the Apigee in Cloud console, go to theDistribution > Portals page.

   Go to Portals

2. Select your portal in the list.

3. SelectSettings.

4. Click theDomains tab.

5. ClickDisable.

6. ClickDisable at the prompt to confirm the operation.

The custom domain is disabled and the fields are cleared.