Configure Network for Remote API Access by a Yeastar FQDN

With a Yeastar FQDN, you can remotely access Yeastar P-Series APIs via a secure tunnel, without the need of configuring public IP and port forwarding for the PBX. This topic describes how to configure network for remote API access via FQDN.


You have subscribed any of the following plans:
  • Standard Plan
  • Enterprise Plan
  • Ultimate Plan


  1. Log in to PBX web portal, go to System > Network > Yeastar FQDN.
  2. Turn on Yeastar FQDN.
  3. In the Fully Qualified Domain Name (FQDN) field, set up the FQDN domain name.
    1. Select a domain name from the drop-down list.
    2. Enter a host name in the first field.
      Note: Think twice before you enter the hostname. The FQDN cannot be changed after you save the configurations.

      For example, select domain name and enter hostname yeastardocs, you will get an FQDN

  4. Enable remote API access feature and configure usage permission.
    1. In the Features section, go to the Remote Access tab.
    2. Click beside the API Access.
    3. In the pop-up window, complete the following settings according to your need.

      • Name: Display the remote access feature name, and cannot be edited.
      • Status: Select Enabled.
      • Remote Access Service Port: Display the remote API access port 443. The port is assigned by Remote Access Service automatically.
      • Enable IP Restriction: Optional. Select the checkbox of the option, and add at least one permitted IP address and subnet mask.

        If you configure this option, only the permitted IP address(es) can use the remote access feature.

    4. Click Confirm.
  5. Click Save.


You can now remotely access P-Series APIs via the FQDN.

What to do next

If your subscription trial period is up or the subscription is not renewed on time, your FQDN will be suspended. To ensure that your FQDN won't be taken by others, you need to subscribe or renew Standard Plan, Enterprise Plan or Ultimate Plan in 60 days.