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

    This must be a third-level domain or higher (for example, www.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>
      How to find your API gateway service domain
      1. Go to the management console.
      2. Select the folder where the API gateway is located and in the list of services, API Gateway
      3. Select the API gateway.
      4. In the window that opens, go to Overview. You can see the service domain under General information.

    2. In the management console, select the folder where the API gateway is located.

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

      1. Create a certificate from Let's Encrypt®.
      2. Confirm the rights for the domain.
      3. When the certificate status changes to Issued, create a domain. In the Certificate field, select the certificate that you created in Step 3.1.

      Note

      The Let's Encrypt® certificate is valid for 90 days. You need to update it on time. In some cases, domain rights checks are performed automatically.

    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 and select the domain.