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
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.
API Portalrequires the following hostnames to be resolvable:
Hostname(if using portal.conf)
Hostname(if using values.yaml)
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.
The APIM tenant Gateway that contains the externally facing Portal APIs.
The analytics endpoint that the tenant Gateway sends the analytic data to.
The broker’s endpoint used by the federated deployment.
The enrollment endpoint. Gateway, with the associated enrollment token access this endpoint to register itself with the portal
The SSO endpoint references the public routes exposed by the PSSG container (analytics, enroll, and SSO), particularly SSO.
The endpoint to synchronize APIs, applications, and account plans between the Portal and its managed Gateways.
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
hostsfile to point to the host serving the API Portal from the system you want to access it from.
Follow these steps:
- Obtain the IP for the system running the API Portal.
- On the system that you want to access API Portal, open and edit thehostsfile.
- On Windows, the file is located inc:\windows\system32\drivers\etc\hosts
- On Linux or MacOS, the file is located in/etc/hosts
- Add the following entry in the host file. Substitute<IP>with the IP to your instance andexample.comaccordingly.<IP> apim.example.com apim-ssg.example.com analytics.example.com broker.example.com sso.example.com sync.example.com enroll.example.comThis hosts entry must be added to any system requesting to access the API Portal without a DNS server.