Get started
Yandex API Gateway

Connecting a domain

Written by

    You can connect your own domain to access the API gateway. You can connect multiple domains to a single API gateway. In this case, the domain is identified by the Host header.

    Warning

    It must be a third-level domain or lower. For example, you can connect the www.example.com domain but not example.com. This has to do with how CNAME records are processed on DNS hosting. Learn more in RFC 1912, Section 2.4.

    To connect a domain to an API gateway:

    1. Host a CNAME record with your DNS provider or on your own DNS server:

      <domain> IN CNAME <API gateway service domain>

      To find out an API gateway's service domain:

      1. Go to the management console.
      2. Select the folder where the API gateway is located, and in the service list, select API Gateway.
      3. Select the API gateway.
      4. You can see the service domain under General information.

      Domain names must end in a dot.

    2. In the management console, select the folder containing the API gateway.

    3. In the list of services, select Certificate Manager and:

      1. Create a Let's Encrypt® certificate or a user certificate.

        Note

        Be sure to timely update your certificates. Learn more about updating Let's Encrypt® certificates and user certificates.

      2. Wait for the certificate status to change to Issued.

    4. Go back to the folder page.

    5. In the list of services, select API Gateway and:

      1. Select the API gateway.
      2. In the window that opens, go to Domains.
      3. Click Connect, select a certificate, and enter a domain name (FQDN).