Deleting an API gateway label

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.

To delete an API gateway label, update its current labels by removing the ones you do not need. Run this command:

yc serverless api-gateway update <API_gateway_name> \
  --labels <key>=<value>[,<key>=<value>]

Result:

id: d5de8465hjvo********
folder_id: b1g681qpemb4********
created_at: "2024-11-26T20:16:50.785Z"
name: my-gateway
labels:
  test: test
  version: beta
status: ACTIVE
domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net
connectivity: {}
log_options:
  folder_id: b1g681qpemb4********
execution_timeout: 300s

To delete all API gateway labels, provide an empty value:

yc serverless api-gateway update <API_gateway_name> --labels ""

To check that the API gateway labels were updated, use the management console or this CLI command:

yc serverless api-gateway get <API_gateway_name>

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 relevant documentation on the Terraform website or its mirror.

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

To delete an API gateway label:

1. Open the Terraform configuration file and delete the label you no longer need in the labels section.

   Example API gateway description in the Terraform configuration:

   resource "yandex_api_gateway" "test-api-gateway" {
     name        = "my-gateway"
     description = "any description"
     labels      = {
       label       = "label"
       empty-label = ""
     }
     spec = <<-EOT
       openapi: 3.0.0
       info:
         title: Sample API
         version: 1.0.0
       paths:
         /:
           get:
             x-yc-apigateway-integration:
               type: dummy
               content:
                 '*': Hello, World!
               http_code: 200
               http_headers:
                 Content-Type: text/plain
     EOT
   }
   

   For more information about the yandex_api_gateway resource parameters in Terraform, see the provider documentation.

2. Update the resources:

   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.

To check that the API gateway labels were updated, use the management console or this CLI command:

yc serverless api-gateway get <API_gateway_name>

To delete an API gateway label, use the update REST API method for the ApiGateway resource or the ApiGatewayService/Update gRPC API call.