Konnect labels

Uses: Kong Gateway
Related Documentation
Incompatible with
on-prem
Related Resources

Labels are key:value pairs. They are case-sensitive attributes associated with entities. Labels allow an organization to specify metadata on an entity.

For example, you might use the label location:us-west, where location is the key and the us-west is the value.

Label requirements

A maximum of 5 user-defined labels are allowed on each resource.

Each label must follow these requirements:

  • Both the key and value must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]). You can use dashes (-), underscores (_), dots (.), and alphanumeric characters in between.
  • The key must not start with kong, konnect, insomnia, mesh, kic, kuma, or _. These strings are reserved for Kong.
  • The value must not be empty.

Keys are case-sensitive, but values are not.

Setting labels

You can use labels separately on the Control Plane and Data Plane nodes:

  • On the Control Plane, you can set a label for control plane and for individual API products.
  • On Data Plane nodes, set labels through kong.conf or via environment variables using the cluster_dp_labels property. The Konnect API exposes these labels through the /nodes endpoint.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!