# Adding a label to an API gateway

{% list tabs group=instructions %}

- Management console {#console}

  1. In the [management console](https://console.yandex.cloud), navigate to the folder containing the API gateway.
  1. Navigate to **API Gateway**.
  1. In the API gateway row, click ![image](../../_assets/console-icons/ellipsis.svg) and select ![image](../../_assets/console-icons/pencil.svg) **Edit**.
  1. In the **Labels** field, click **Add label**.
  1. Enter the key and value, and press **Enter**.
  1. Click **Save**.

- CLI {#cli}

  If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install).

  The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) 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 add an API gateway label, run this command:

  {% note warning %}
  
  The existing labels (`labels`) will be completely overwritten by the ones you provide in your request.
  
  {% endnote %}

  ```bash
  yc serverless api-gateway update <API_gateway_name> \
    --labels <key>=<value>[,<key>=<value>]
  ```
  
  Result:
  
  ```text
  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](https://console.yandex.cloud) or this [CLI](../../cli/index.md) command:
  
  ```bash
  yc serverless api-gateway get <API_gateway_name>
  ```

- Terraform {#tf}

  With [Terraform](https://www.terraform.io/), 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](https://github.com/hashicorp/terraform/blob/main/LICENSE). The [Yandex Cloud provider for Terraform](https://github.com/yandex-cloud/terraform-provider-yandex) is distributed under the [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/) license.
  
  For more information about the provider resources, see the relevant documentation on the [Terraform](https://www.terraform.io/docs/providers/yandex/index.html) website or [its mirror](../../terraform/index.md).

  If you do not have Terraform yet, [install it and configure the Yandex Cloud provider](../../tutorials/infrastructure-management/terraform-quickstart.md#install-terraform).
  
  
  To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), [authenticate](../../terraform/authentication.md) using the appropriate method.

  To add an API gateway label:

  1. In the Terraform configuration file, add the `labels` section to list labels in `<key>:"<value>"` format.

      Example API gateway description in the Terraform configuration:
      
      ```hcl
      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](../../terraform/resources/api_gateway.md).

  1. Create the resources:

      1. In the terminal, navigate to the configuration file directory.
      1. Make sure the configuration is correct using this command:
      
         ```bash
         terraform validate
         ```
      
         If the configuration is valid, you will get this message:
      
         ```bash
         Success! The configuration is valid.
         ```
      
      1. Run this command:
      
         ```bash
         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.
      1. Apply the configuration changes:
      
         ```bash
         terraform apply
         ```
      
      1. Type `yes` and press **Enter** to confirm the changes.

  To check that the API gateway labels were updated, use the [management console](https://console.yandex.cloud) or this [CLI](../../cli/index.md) command:
  
  ```bash
  yc serverless api-gateway get <API_gateway_name>
  ```

- API {#api}

  To add an API gateway label, use the [update](../apigateway/api-ref/ApiGateway/update.md) REST API method for the [ApiGateway](../apigateway/api-ref/ApiGateway/index.md) resource or the [ApiGatewayService/Update](../apigateway/api-ref/grpc/ApiGateway/update.md) gRPC API call.

{% endlist %}