Updating an API gateway label

Written by

Updated at May 5, 2025

CLI

Terraform

API

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

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

To update an API gateway label, 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

You can specify multiple <key>=<value> pairs separated by commas.

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

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

To update an API gateway label:

Open the Terraform configuration file and edit 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:
1. In the terminal, change to the folder where you edited the configuration file.
2. 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.
```
3. 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.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.

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 update an API gateway label, use the update REST API method for the ApiGateway resource or the ApiGatewayService/Update gRPC API call.

Updating an API gateway label

Was the article helpful?