terraform-provider-netbird/docs/data-sources/setup_key.md

page_title, subcategory, description

page_title	subcategory	description
netbird_setup_key Data Source - netbird		Read SetupKey settings and metadata, see NetBird Docs https://docs.netbird.io/how-to/register-machines-using-setup-keys for more information. This can not read the plain SetupKey.

netbird_setup_key (Data Source)

Read SetupKey settings and metadata, see NetBird Docs for more information.

This can not read the plain SetupKey.

Example Usage

# Retrieve by id
data "netbird_setup_key" "example" {
  id = "TF Test"
}

# Retrieve by Name
data "netbird_setup_key" "example" {
  name = "TF Test"
}

Schema

Optional

• id (String) SetupKey ID
• name (String) SetupKey Name

Read-Only

• allow_extra_dns_labels (Boolean) Allow extra DNS labels to be added to the peer
• auto_groups (List of String) List of groups to automatically assign to peers created through this setup key
• ephemeral (Boolean) Indicate that the peer will be ephemeral or not, ephemeral peers are deleted after 10 minutes of inactivity
• expires (String) SetupKey Expiration Date
• last_used (String) Last usage time
• revoked (Boolean) Set to true to revoke setup key
• state (String) Setup key state (valid or expired)
• type (String) Setup Key type (one-off or reusable)
• updated_at (String) Creation timestamp
• usage_limit (Number) Maximum number of times SetupKey can be used (0 for unlimited)
• used_times (Number) Number of times Setup Key was used
• valid (Boolean) True if setup key can be used to create more Peers