mirror of
https://github.com/netbirdio/terraform-provider-netbird.git
synced 2026-05-22 17:13:16 -07:00
108 lines
3.0 KiB
Markdown
108 lines
3.0 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "netbird_reverse_proxy_service Data Source - netbird"
|
|
subcategory: ""
|
|
description: |-
|
|
Look up a reverse proxy service by ID, name, or domain.
|
|
---
|
|
|
|
# netbird_reverse_proxy_service (Data Source)
|
|
|
|
Look up a reverse proxy service by ID, name, or domain.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# Retrieve by name
|
|
data "netbird_reverse_proxy_service" "example" {
|
|
name = "my-service"
|
|
}
|
|
|
|
# Retrieve by domain
|
|
data "netbird_reverse_proxy_service" "by_domain" {
|
|
domain = "app.example.netbird.cloud"
|
|
}
|
|
|
|
# Retrieve by ID
|
|
data "netbird_reverse_proxy_service" "by_id" {
|
|
id = "cvit5sjl0ubs73aslrkg"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Optional
|
|
|
|
- `domain` (String) Domain for the service
|
|
- `id` (String) Service ID
|
|
- `name` (String) Service name
|
|
|
|
### Read-Only
|
|
|
|
- `auth` (Attributes) Authentication configuration (see [below for nested schema](#nestedatt--auth))
|
|
- `enabled` (Boolean) Whether the service is enabled
|
|
- `pass_host_header` (Boolean) When true, the original client Host header is passed through to the backend
|
|
- `proxy_cluster` (String) The proxy cluster handling this service
|
|
- `rewrite_redirects` (Boolean) When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
|
- `targets` (Attributes List) List of target backends for this service (see [below for nested schema](#nestedatt--targets))
|
|
|
|
<a id="nestedatt--auth"></a>
|
|
### Nested Schema for `auth`
|
|
|
|
Read-Only:
|
|
|
|
- `bearer_auth` (Attributes) Bearer token authentication (see [below for nested schema](#nestedatt--auth--bearer_auth))
|
|
- `link_auth` (Attributes) Link authentication (see [below for nested schema](#nestedatt--auth--link_auth))
|
|
- `password_auth` (Attributes) Password authentication (see [below for nested schema](#nestedatt--auth--password_auth))
|
|
- `pin_auth` (Attributes) PIN authentication (see [below for nested schema](#nestedatt--auth--pin_auth))
|
|
|
|
<a id="nestedatt--auth--bearer_auth"></a>
|
|
### Nested Schema for `auth.bearer_auth`
|
|
|
|
Read-Only:
|
|
|
|
- `distribution_groups` (List of String) List of group IDs that can use bearer auth
|
|
- `enabled` (Boolean)
|
|
|
|
|
|
<a id="nestedatt--auth--link_auth"></a>
|
|
### Nested Schema for `auth.link_auth`
|
|
|
|
Read-Only:
|
|
|
|
- `enabled` (Boolean)
|
|
|
|
|
|
<a id="nestedatt--auth--password_auth"></a>
|
|
### Nested Schema for `auth.password_auth`
|
|
|
|
Read-Only:
|
|
|
|
- `enabled` (Boolean)
|
|
- `password` (String, Sensitive)
|
|
|
|
|
|
<a id="nestedatt--auth--pin_auth"></a>
|
|
### Nested Schema for `auth.pin_auth`
|
|
|
|
Read-Only:
|
|
|
|
- `enabled` (Boolean)
|
|
- `pin` (String, Sensitive)
|
|
|
|
|
|
|
|
<a id="nestedatt--targets"></a>
|
|
### Nested Schema for `targets`
|
|
|
|
Read-Only:
|
|
|
|
- `enabled` (Boolean) Whether this target is enabled
|
|
- `host` (String) Backend IP or domain for this target
|
|
- `path` (String) URL path prefix for this target
|
|
- `port` (Number) Backend port for this target
|
|
- `protocol` (String) Protocol to use when connecting to the backend (http, https)
|
|
- `target_id` (String) Target ID (resource or peer ID)
|
|
- `target_type` (String) Target type (peer, host, domain, subnet)
|