ApiShieldLabel

Source: src/Cloudflare/ApiShield/Label.ts

A Cloudflare API Shield user label — a zone-scoped tag that can be attached to registered API operations to organize and filter them (e.g. by team, service, or sensitivity).

The label’s name is its identity (and Cloudflare limits it to 24 characters), so renaming triggers a replacement; only the description is mutable in place. Deleting a label detaches it from any operations server-side.

Creating a Label

Label with a generated name

const label = yield* Cloudflare.ApiShieldLabel("TeamPayments", {
  zoneId: zone.zoneId,
  description: "endpoints owned by the payments team",
});

Label with an explicit name

yield* Cloudflare.ApiShieldLabel("Pii", {
  zoneId: zone.zoneId,
  name: "pii",
  description: "endpoints that return personal data",
});