Configure Your DNS Server

To access the aan, configure the hostname resolution on your corporate DNS server.
To access the 
API Portal
, configure the hostname resolution on your corporate DNS server.
The hostnames must match the values you enter for PORTAL_DOMAIN (in portal.conf) or 
user.Domain
 (in values.yaml) during installation. 
The following examples use  as the PORTAL_DOMAIN or 
user.Domain
.
The PORTAL_TENANT_ID (in portal.conf) or 
user.defaultTenantId
 (in values.yaml) value observes the following restrictions:
  • No hyphens
  • No special characters
  • Lowercase characters only
  • 13 characters maximum
The default value of 'apim' is recommended.
CA 
API Portal
 requires the following hostnames to be resolvable:
Hostname
 (if using portal.conf)
Hostname 
(if using values.yaml)
 
Description
 
 
Example
 
PORTAL_TENANT_ID.PORTAL_DOMAIN 
<user.defaultTenantId>.<user.Domain>
The APIM internal tenant web page that contains the Portal API.
The PORTAL_TENANT_ID and PORTAL_DOMAIN are combined to form the URL that is used to access the API Developer Portal.
apim.example.com
PORTAL_TENANT_ID-ssg.PORTAL_DOMAIN
<user.defaultTenantId>-ssg.<user.Domain>
The APIM tenant Gateway that contains the externally facing Portal APIs.
apim-ssg.example.com
analytics.PORTAL_DOMAIN
analytics.<user.Domain>
The analytics endpoint that the tenant Gateway sends the analytic data to.
analytics.example.com
broker.PORTAL_DOMAIN
broker.<user.Domain>
The broker’s endpoint used by the federated deployment.
broker.example.com
enroll.PORTAL_DOMAIN
enroll.<user.Domain>
The enrollment endpoint. Gateway, with the associated enrollment token access this endpoint to register itself with the portal
enroll.example.com
sso.PORTAL_DOMAIN
sso.<user.Domain>
The SSO endpoint references the public routes exposed by the PSSG container (analytics, enroll, and SSO), particularly SSO. 
 sso.example.com
<subdomain>9443/portalAuth/sso/validateSaml endpoint
sync.PORTAL_DOMAIN
sync.<user.Domain>
The endpoint to synchronize APIs, applications, and account plans between the Portal and its managed Gateways.
sync.example.com
Edit Hosts File for Local Access (Docker Swarm)
Work with your network administrator to make the required changes. In a development environment, it may not be ideal to create a DNS record if the application instance is meant to be temporary. In this case, you can edit the 
hosts
 file to point to the host serving the API Portal from the system you want to access it from. 
 
Follow these steps:
 
  1. Obtain the IP for the system running the API Portal.
  2. On the system that you want to access API Portal, open and edit the 
    hosts
     file.
    • On Windows, the file is located in 
      c:\windows\system32\drivers\etc\hosts
       
    • On Linux or MacOS, the file is located in 
      /etc/hosts
       
  3. Add the following entry in the host file. Substitute 
    <IP>
     with the IP to your instance and 
    example.com
     accordingly. 
    <IP> apim.example.com apim-ssg.example.com analytics.example.com broker.example.com sso.example.com sync.example.com enroll.example.com
    This hosts entry must be added to any system requesting to access the API Portal without a DNS server.