Deleting an API gateway label
- In the management console
, go the folder containing the API gateway. - In the list of services, select API Gateway.
- In the API gateway row, click
and select Edit. - In the Labels field, select the appropriate label and click
next to its name. - Click Save.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
settings.
To delete an API gateway label, update its current labels by removing the labels you do not need. Run this command:
Warning
The existing labels (labels
) will be completely overwritten by the ones you provide in your request.
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
yc serverless api-gateway get <API_gateway_name>
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
To delete an API gateway label:
-
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 . -
Update resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using the command:
terraform validate
If the configuration is correct, the following message is returned:
Success! The configuration is valid.
-
Run the command:
terraform plan
The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
-
To check that the API gateway labels were updated, use the management console
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.