Removing a domain

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

1. View the description of the CLI command for removing a domain:

   yc serverless api-gateway remove-domain --help
   

2. Run this command:

   yc serverless api-gateway remove-domain <API_gateway_ID> --domain-id <domain_ID>
   

3. Delete the resource record created when adding the domain to the API gateway:

   • If your domain is delegated to Cloud DNS:

     1. Get a list of all records in the DNS zone by specifying the relevant zone ID:

        yc dns zone list-records <DNS_zone_ID>
        

        The record in question is of the ANAME type and has a value in d5dm1lba80md********.i9******.apigw.yandexcloud.net format.

     2. Delete the record:

        yc dns zone delete-records <DNS_zone_ID> \
          --record "<domain_name> <TTL> <record_type> <value>"
        

   • If a third-party DNS provider manages your domain, delete the record on the domain management page of your provider.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the guides on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

1. Open the Terraform configuration file and delete the custom_domains section with the domain to remove from the yandex_api_gateway description:

   resource "yandex_api_gateway" "<API_gateway_name>" {
     name = "<API_gateway_name>"
     ...
     custom_domains {
       fqdn           = "<domain_name>"
       certificate_id = "<certificate_ID>"
     }
   }
   

   For more information about the properties of the yandex_api_gateway resource, see this provider guide.

2. Apply the changes:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

3. Delete the resource record created when adding the domain to the API gateway:

   • If your domain is delegated to Cloud DNS, delete the ANAME record in the DNS zone.

   • If a third-party DNS provider manages your domain, delete the record on the domain management page of your provider.

To remove a domain from an API gateway, use the removeDomain REST API method for the ApiGateway resource or the ApiGatewayService/RemoveDomain gRPC API call.

Delete the resource record created when adding the domain to the API gateway:

• If your domain is delegated to Cloud DNS, use the updateRecordSets REST API method for the DnsZone resource or the DnsZoneService/UpdateRecordSets gRPC API call.

• If a third-party DNS provider manages your domain, delete the record on the domain management page of your provider.