mirror of
https://github.com/netbirdio/netbird.git
synced 2026-10-05 13:09:07 +02:00
merge main
This commit is contained in:
@@ -347,6 +347,10 @@ components:
|
||||
description: Set Clients auto-update version. "latest", "disabled", or a specific version (e.g "0.50.1")
|
||||
type: string
|
||||
example: "0.51.2"
|
||||
auto_update_always:
|
||||
description: When true, updates are installed automatically in the background. When false, updates require user interaction from the UI.
|
||||
type: boolean
|
||||
example: false
|
||||
embedded_idp_enabled:
|
||||
description: Indicates whether the embedded identity provider (Dex) is enabled for this account. This is a read-only field.
|
||||
type: boolean
|
||||
@@ -2822,6 +2826,10 @@ components:
|
||||
type: string
|
||||
description: "City name from geolocation"
|
||||
example: "San Francisco"
|
||||
subdivision_code:
|
||||
type: string
|
||||
description: "First-level administrative subdivision ISO code (e.g. state/province)"
|
||||
example: "CA"
|
||||
bytes_upload:
|
||||
type: integer
|
||||
format: int64
|
||||
@@ -2832,6 +2840,10 @@ components:
|
||||
format: int64
|
||||
description: "Bytes downloaded (response body size)"
|
||||
example: 8192
|
||||
protocol:
|
||||
type: string
|
||||
description: "Protocol type: http, tcp, or udp"
|
||||
example: "http"
|
||||
required:
|
||||
- id
|
||||
- service_id
|
||||
@@ -2944,12 +2956,32 @@ components:
|
||||
id:
|
||||
type: string
|
||||
description: Service ID
|
||||
example: "cs8i4ug6lnn4g9hqv7mg"
|
||||
name:
|
||||
type: string
|
||||
description: Service name
|
||||
example: "myapp.example.netbird.app"
|
||||
domain:
|
||||
type: string
|
||||
description: Domain for the service
|
||||
example: "myapp.example.netbird.app"
|
||||
mode:
|
||||
type: string
|
||||
description: Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
enum: [http, tcp, udp, tls]
|
||||
default: http
|
||||
example: "http"
|
||||
listen_port:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 65535
|
||||
description: Port the proxy listens on (L4/TLS only)
|
||||
example: 8443
|
||||
port_auto_assigned:
|
||||
type: boolean
|
||||
description: Whether the listen port was auto-assigned
|
||||
readOnly: true
|
||||
example: false
|
||||
proxy_cluster:
|
||||
type: string
|
||||
description: The proxy cluster handling this service (derived from domain)
|
||||
@@ -2962,14 +2994,19 @@ components:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether the service is enabled
|
||||
example: true
|
||||
pass_host_header:
|
||||
type: boolean
|
||||
description: When true, the original client Host header is passed through to the backend instead of being rewritten to the backend's address
|
||||
example: false
|
||||
rewrite_redirects:
|
||||
type: boolean
|
||||
description: When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
example: false
|
||||
auth:
|
||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
||||
access_restrictions:
|
||||
$ref: '#/components/schemas/AccessRestrictions'
|
||||
meta:
|
||||
$ref: '#/components/schemas/ServiceMeta'
|
||||
required:
|
||||
@@ -3013,9 +3050,23 @@ components:
|
||||
name:
|
||||
type: string
|
||||
description: Service name
|
||||
example: "myapp.example.netbird.app"
|
||||
domain:
|
||||
type: string
|
||||
description: Domain for the service
|
||||
example: "myapp.example.netbird.app"
|
||||
mode:
|
||||
type: string
|
||||
description: Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
enum: [http, tcp, udp, tls]
|
||||
default: http
|
||||
example: "http"
|
||||
listen_port:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 65535
|
||||
description: Port the proxy listens on (L4/TLS only). Set to 0 for auto-assignment.
|
||||
example: 5432
|
||||
targets:
|
||||
type: array
|
||||
items:
|
||||
@@ -3025,19 +3076,22 @@ components:
|
||||
type: boolean
|
||||
description: Whether the service is enabled
|
||||
default: true
|
||||
example: true
|
||||
pass_host_header:
|
||||
type: boolean
|
||||
description: When true, the original client Host header is passed through to the backend instead of being rewritten to the backend's address
|
||||
example: false
|
||||
rewrite_redirects:
|
||||
type: boolean
|
||||
description: When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
example: false
|
||||
auth:
|
||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
||||
access_restrictions:
|
||||
$ref: '#/components/schemas/AccessRestrictions'
|
||||
required:
|
||||
- name
|
||||
- domain
|
||||
- targets
|
||||
- auth
|
||||
- enabled
|
||||
ServiceTargetOptions:
|
||||
type: object
|
||||
@@ -3045,13 +3099,16 @@ components:
|
||||
skip_tls_verify:
|
||||
type: boolean
|
||||
description: Skip TLS certificate verification for this backend
|
||||
example: false
|
||||
request_timeout:
|
||||
type: string
|
||||
description: Per-target response timeout as a Go duration string (e.g. "30s", "2m")
|
||||
example: "30s"
|
||||
path_rewrite:
|
||||
type: string
|
||||
description: Controls how the request path is rewritten before forwarding to the backend. Default strips the matched prefix. "preserve" keeps the full original request path.
|
||||
enum: [preserve]
|
||||
example: "preserve"
|
||||
custom_headers:
|
||||
type: object
|
||||
description: Extra headers sent to the backend. Hop-by-hop and proxy-managed headers (Host, Connection, Transfer-Encoding, etc.) are rejected.
|
||||
@@ -3061,32 +3118,50 @@ components:
|
||||
additionalProperties:
|
||||
type: string
|
||||
pattern: '^[^\r\n]*$'
|
||||
example: {"X-Custom-Header": "value"}
|
||||
proxy_protocol:
|
||||
type: boolean
|
||||
description: Send PROXY Protocol v2 header to this backend (TCP/TLS only)
|
||||
example: false
|
||||
session_idle_timeout:
|
||||
type: string
|
||||
description: Idle timeout before a UDP session is reaped, as a Go duration string (e.g. "30s", "2m").
|
||||
example: "2m"
|
||||
ServiceTarget:
|
||||
type: object
|
||||
properties:
|
||||
target_id:
|
||||
type: string
|
||||
description: Target ID
|
||||
example: "cs8i4ug6lnn4g9hqv7mg"
|
||||
target_type:
|
||||
type: string
|
||||
description: Target type (e.g., "peer", "resource")
|
||||
enum: [peer, resource]
|
||||
description: Target type
|
||||
enum: [peer, host, domain, subnet]
|
||||
example: "subnet"
|
||||
path:
|
||||
type: string
|
||||
description: URL path prefix for this target
|
||||
description: URL path prefix for this target (HTTP only)
|
||||
example: "/"
|
||||
protocol:
|
||||
type: string
|
||||
description: Protocol to use when connecting to the backend
|
||||
enum: [http, https]
|
||||
enum: [http, https, tcp, udp]
|
||||
example: "http"
|
||||
host:
|
||||
type: string
|
||||
description: Backend ip or domain for this target
|
||||
example: "10.10.0.1"
|
||||
port:
|
||||
type: integer
|
||||
description: Backend port for this target. Use 0 or omit to use the scheme default (80 for http, 443 for https).
|
||||
minimum: 1
|
||||
maximum: 65535
|
||||
description: Backend port for this target
|
||||
example: 8080
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether this target is enabled
|
||||
example: true
|
||||
options:
|
||||
$ref: '#/components/schemas/ServiceTargetOptions'
|
||||
required:
|
||||
@@ -3106,15 +3181,73 @@ components:
|
||||
$ref: '#/components/schemas/BearerAuthConfig'
|
||||
link_auth:
|
||||
$ref: '#/components/schemas/LinkAuthConfig'
|
||||
header_auths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/HeaderAuthConfig'
|
||||
HeaderAuthConfig:
|
||||
type: object
|
||||
description: Static header-value authentication. The proxy checks that the named header matches the configured value.
|
||||
properties:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether header auth is enabled
|
||||
example: true
|
||||
header:
|
||||
type: string
|
||||
description: HTTP header name to check (e.g. "Authorization", "X-API-Key")
|
||||
example: "X-API-Key"
|
||||
value:
|
||||
type: string
|
||||
description: Expected header value. For Basic auth use "Basic base64(user:pass)". For Bearer use "Bearer token". Cleared in responses.
|
||||
example: "my-secret-api-key"
|
||||
required:
|
||||
- enabled
|
||||
- header
|
||||
- value
|
||||
AccessRestrictions:
|
||||
type: object
|
||||
description: Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
|
||||
properties:
|
||||
allowed_cidrs:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: cidr
|
||||
example: "192.168.1.0/24"
|
||||
description: CIDR allowlist. If non-empty, only IPs matching these CIDRs are allowed.
|
||||
blocked_cidrs:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: cidr
|
||||
example: "10.0.0.0/8"
|
||||
description: CIDR blocklist. Connections from these CIDRs are rejected. Evaluated after allowed_cidrs.
|
||||
allowed_countries:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
pattern: '^[a-zA-Z]{2}$'
|
||||
example: "US"
|
||||
description: ISO 3166-1 alpha-2 country codes to allow. If non-empty, only these countries are permitted.
|
||||
blocked_countries:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
pattern: '^[a-zA-Z]{2}$'
|
||||
example: "DE"
|
||||
description: ISO 3166-1 alpha-2 country codes to block.
|
||||
PasswordAuthConfig:
|
||||
type: object
|
||||
properties:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether password auth is enabled
|
||||
example: true
|
||||
password:
|
||||
type: string
|
||||
description: Auth password
|
||||
example: "s3cret"
|
||||
required:
|
||||
- enabled
|
||||
- password
|
||||
@@ -3124,9 +3257,11 @@ components:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether PIN auth is enabled
|
||||
example: false
|
||||
pin:
|
||||
type: string
|
||||
description: PIN value
|
||||
example: "1234"
|
||||
required:
|
||||
- enabled
|
||||
- pin
|
||||
@@ -3136,10 +3271,12 @@ components:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether bearer auth is enabled
|
||||
example: true
|
||||
distribution_groups:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: "ch8i4ug6lnn4g9hqv7mg"
|
||||
description: List of group IDs that can use bearer auth
|
||||
required:
|
||||
- enabled
|
||||
@@ -3149,6 +3286,7 @@ components:
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether link auth is enabled
|
||||
example: false
|
||||
required:
|
||||
- enabled
|
||||
ProxyTokenRequest:
|
||||
@@ -3234,17 +3372,29 @@ components:
|
||||
id:
|
||||
type: string
|
||||
description: Domain ID
|
||||
example: "ds8i4ug6lnn4g9hqv7mg"
|
||||
domain:
|
||||
type: string
|
||||
description: Domain name
|
||||
example: "example.netbird.app"
|
||||
validated:
|
||||
type: boolean
|
||||
description: Whether the domain has been validated
|
||||
example: true
|
||||
type:
|
||||
$ref: '#/components/schemas/ReverseProxyDomainType'
|
||||
target_cluster:
|
||||
type: string
|
||||
description: The proxy cluster this domain is validated against (only for custom domains)
|
||||
example: "eu.proxy.netbird.io"
|
||||
supports_custom_ports:
|
||||
type: boolean
|
||||
description: Whether the cluster supports binding arbitrary TCP/UDP ports
|
||||
example: true
|
||||
require_subdomain:
|
||||
type: boolean
|
||||
description: Whether a subdomain label is required in front of this domain. When true, the domain cannot be used bare.
|
||||
example: false
|
||||
required:
|
||||
- id
|
||||
- domain
|
||||
@@ -3256,9 +3406,11 @@ components:
|
||||
domain:
|
||||
type: string
|
||||
description: Domain name
|
||||
example: "myapp.example.com"
|
||||
target_cluster:
|
||||
type: string
|
||||
description: The proxy cluster this domain should be validated against
|
||||
example: "eu.proxy.netbird.io"
|
||||
required:
|
||||
- domain
|
||||
- target_cluster
|
||||
@@ -4328,6 +4480,12 @@ components:
|
||||
requires_authentication:
|
||||
description: Requires authentication
|
||||
content: { }
|
||||
conflict:
|
||||
description: Conflict
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
securitySchemes:
|
||||
BearerAuth:
|
||||
type: http
|
||||
@@ -9672,6 +9830,58 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
/api/reverse-proxies/clusters:
|
||||
get:
|
||||
summary: List available proxy clusters
|
||||
description: Returns a list of available proxy clusters with their connection status
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
responses:
|
||||
'200':
|
||||
description: A JSON Array of proxy clusters
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ProxyCluster'
|
||||
'401':
|
||||
"$ref": "#/components/responses/requires_authentication"
|
||||
'403':
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/clusters/{clusterId}:
|
||||
delete:
|
||||
summary: Delete a self-hosted proxy cluster
|
||||
description: Removes a self-hosted (BYOP) proxy cluster and disconnects it. Only self-hosted clusters can be deleted.
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
parameters:
|
||||
- in: path
|
||||
name: clusterId
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The unique identifier of the proxy cluster
|
||||
responses:
|
||||
'200':
|
||||
description: Proxy cluster deleted successfully
|
||||
content: { }
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
"$ref": "#/components/responses/requires_authentication"
|
||||
'403':
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'404':
|
||||
"$ref": "#/components/responses/not_found"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/proxy-tokens:
|
||||
get:
|
||||
summary: List Proxy Tokens
|
||||
@@ -9797,29 +10007,8 @@ paths:
|
||||
"$ref": "#/components/responses/requires_authentication"
|
||||
'403':
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/clusters:
|
||||
get:
|
||||
summary: List available proxy clusters
|
||||
description: Returns a list of available proxy clusters with their connection status
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
responses:
|
||||
'200':
|
||||
description: A JSON Array of proxy clusters
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ProxyCluster'
|
||||
'401':
|
||||
"$ref": "#/components/responses/requires_authentication"
|
||||
'403':
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'409':
|
||||
"$ref": "#/components/responses/conflict"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/clusters/{clusterId}:
|
||||
@@ -9918,6 +10107,8 @@ paths:
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'404':
|
||||
"$ref": "#/components/responses/not_found"
|
||||
'409':
|
||||
"$ref": "#/components/responses/conflict"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
delete:
|
||||
|
||||
@@ -880,6 +880,30 @@ func (e SentinelOneMatchAttributesNetworkStatus) Valid() bool {
|
||||
}
|
||||
}
|
||||
|
||||
// Defines values for ServiceMode.
|
||||
const (
|
||||
ServiceModeHttp ServiceMode = "http"
|
||||
ServiceModeTcp ServiceMode = "tcp"
|
||||
ServiceModeTls ServiceMode = "tls"
|
||||
ServiceModeUdp ServiceMode = "udp"
|
||||
)
|
||||
|
||||
// Valid indicates whether the value is a known member of the ServiceMode enum.
|
||||
func (e ServiceMode) Valid() bool {
|
||||
switch e {
|
||||
case ServiceModeHttp:
|
||||
return true
|
||||
case ServiceModeTcp:
|
||||
return true
|
||||
case ServiceModeTls:
|
||||
return true
|
||||
case ServiceModeUdp:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// Defines values for ServiceMetaStatus.
|
||||
const (
|
||||
ServiceMetaStatusActive ServiceMetaStatus = "active"
|
||||
@@ -910,10 +934,36 @@ func (e ServiceMetaStatus) Valid() bool {
|
||||
}
|
||||
}
|
||||
|
||||
// Defines values for ServiceRequestMode.
|
||||
const (
|
||||
ServiceRequestModeHttp ServiceRequestMode = "http"
|
||||
ServiceRequestModeTcp ServiceRequestMode = "tcp"
|
||||
ServiceRequestModeTls ServiceRequestMode = "tls"
|
||||
ServiceRequestModeUdp ServiceRequestMode = "udp"
|
||||
)
|
||||
|
||||
// Valid indicates whether the value is a known member of the ServiceRequestMode enum.
|
||||
func (e ServiceRequestMode) Valid() bool {
|
||||
switch e {
|
||||
case ServiceRequestModeHttp:
|
||||
return true
|
||||
case ServiceRequestModeTcp:
|
||||
return true
|
||||
case ServiceRequestModeTls:
|
||||
return true
|
||||
case ServiceRequestModeUdp:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// Defines values for ServiceTargetProtocol.
|
||||
const (
|
||||
ServiceTargetProtocolHttp ServiceTargetProtocol = "http"
|
||||
ServiceTargetProtocolHttps ServiceTargetProtocol = "https"
|
||||
ServiceTargetProtocolTcp ServiceTargetProtocol = "tcp"
|
||||
ServiceTargetProtocolUdp ServiceTargetProtocol = "udp"
|
||||
)
|
||||
|
||||
// Valid indicates whether the value is a known member of the ServiceTargetProtocol enum.
|
||||
@@ -923,6 +973,10 @@ func (e ServiceTargetProtocol) Valid() bool {
|
||||
return true
|
||||
case ServiceTargetProtocolHttps:
|
||||
return true
|
||||
case ServiceTargetProtocolTcp:
|
||||
return true
|
||||
case ServiceTargetProtocolUdp:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
@@ -930,16 +984,22 @@ func (e ServiceTargetProtocol) Valid() bool {
|
||||
|
||||
// Defines values for ServiceTargetTargetType.
|
||||
const (
|
||||
ServiceTargetTargetTypePeer ServiceTargetTargetType = "peer"
|
||||
ServiceTargetTargetTypeResource ServiceTargetTargetType = "resource"
|
||||
ServiceTargetTargetTypeDomain ServiceTargetTargetType = "domain"
|
||||
ServiceTargetTargetTypeHost ServiceTargetTargetType = "host"
|
||||
ServiceTargetTargetTypePeer ServiceTargetTargetType = "peer"
|
||||
ServiceTargetTargetTypeSubnet ServiceTargetTargetType = "subnet"
|
||||
)
|
||||
|
||||
// Valid indicates whether the value is a known member of the ServiceTargetTargetType enum.
|
||||
func (e ServiceTargetTargetType) Valid() bool {
|
||||
switch e {
|
||||
case ServiceTargetTargetTypeDomain:
|
||||
return true
|
||||
case ServiceTargetTargetTypeHost:
|
||||
return true
|
||||
case ServiceTargetTargetTypePeer:
|
||||
return true
|
||||
case ServiceTargetTargetTypeResource:
|
||||
case ServiceTargetTargetTypeSubnet:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
@@ -1216,6 +1276,21 @@ func (e PutApiIntegrationsMspTenantsIdInviteJSONBodyValue) Valid() bool {
|
||||
}
|
||||
}
|
||||
|
||||
// AccessRestrictions Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
|
||||
type AccessRestrictions struct {
|
||||
// AllowedCidrs CIDR allowlist. If non-empty, only IPs matching these CIDRs are allowed.
|
||||
AllowedCidrs *[]string `json:"allowed_cidrs,omitempty"`
|
||||
|
||||
// AllowedCountries ISO 3166-1 alpha-2 country codes to allow. If non-empty, only these countries are permitted.
|
||||
AllowedCountries *[]string `json:"allowed_countries,omitempty"`
|
||||
|
||||
// BlockedCidrs CIDR blocklist. Connections from these CIDRs are rejected. Evaluated after allowed_cidrs.
|
||||
BlockedCidrs *[]string `json:"blocked_cidrs,omitempty"`
|
||||
|
||||
// BlockedCountries ISO 3166-1 alpha-2 country codes to block.
|
||||
BlockedCountries *[]string `json:"blocked_countries,omitempty"`
|
||||
}
|
||||
|
||||
// AccessiblePeer defines model for AccessiblePeer.
|
||||
type AccessiblePeer struct {
|
||||
// CityName Commonly used English name of the city
|
||||
@@ -1307,6 +1382,9 @@ type AccountRequest struct {
|
||||
|
||||
// AccountSettings defines model for AccountSettings.
|
||||
type AccountSettings struct {
|
||||
// AutoUpdateAlways When true, updates are installed automatically in the background. When false, updates require user interaction from the UI.
|
||||
AutoUpdateAlways *bool `json:"auto_update_always,omitempty"`
|
||||
|
||||
// AutoUpdateVersion Set Clients auto-update version. "latest", "disabled", or a specific version (e.g "0.50.1")
|
||||
AutoUpdateVersion *string `json:"auto_update_version,omitempty"`
|
||||
|
||||
@@ -1925,6 +2003,18 @@ type GroupRequest struct {
|
||||
Resources *[]Resource `json:"resources,omitempty"`
|
||||
}
|
||||
|
||||
// HeaderAuthConfig Static header-value authentication. The proxy checks that the named header matches the configured value.
|
||||
type HeaderAuthConfig struct {
|
||||
// Enabled Whether header auth is enabled
|
||||
Enabled bool `json:"enabled"`
|
||||
|
||||
// Header HTTP header name to check (e.g. "Authorization", "X-API-Key")
|
||||
Header string `json:"header"`
|
||||
|
||||
// Value Expected header value. For Basic auth use "Basic base64(user:pass)". For Bearer use "Bearer token". Cleared in responses.
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
// HuntressMatchAttributes Attribute conditions to match when approving agents
|
||||
type HuntressMatchAttributes struct {
|
||||
// DefenderPolicyStatus Policy status of Defender AV for Managed Antivirus.
|
||||
@@ -3246,6 +3336,9 @@ type ProxyAccessLog struct {
|
||||
// Path Path of the request
|
||||
Path string `json:"path"`
|
||||
|
||||
// Protocol Protocol type: http, tcp, or udp
|
||||
Protocol *string `json:"protocol,omitempty"`
|
||||
|
||||
// Reason Reason for the request result (e.g., authentication failure)
|
||||
Reason *string `json:"reason,omitempty"`
|
||||
|
||||
@@ -3258,6 +3351,9 @@ type ProxyAccessLog struct {
|
||||
// StatusCode HTTP status code returned
|
||||
StatusCode int `json:"status_code"`
|
||||
|
||||
// SubdivisionCode First-level administrative subdivision ISO code (e.g. state/province)
|
||||
SubdivisionCode *string `json:"subdivision_code,omitempty"`
|
||||
|
||||
// Timestamp Timestamp when the request was made
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
|
||||
@@ -3345,6 +3441,12 @@ type ReverseProxyDomain struct {
|
||||
// Id Domain ID
|
||||
Id string `json:"id"`
|
||||
|
||||
// RequireSubdomain Whether a subdomain label is required in front of this domain. When true, the domain cannot be used bare.
|
||||
RequireSubdomain *bool `json:"require_subdomain,omitempty"`
|
||||
|
||||
// SupportsCustomPorts Whether the cluster supports binding arbitrary TCP/UDP ports
|
||||
SupportsCustomPorts *bool `json:"supports_custom_ports,omitempty"`
|
||||
|
||||
// TargetCluster The proxy cluster this domain is validated against (only for custom domains)
|
||||
TargetCluster *string `json:"target_cluster,omitempty"`
|
||||
|
||||
@@ -3528,7 +3630,9 @@ type SentinelOneMatchAttributesNetworkStatus string
|
||||
|
||||
// Service defines model for Service.
|
||||
type Service struct {
|
||||
Auth ServiceAuthConfig `json:"auth"`
|
||||
// AccessRestrictions Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
|
||||
AccessRestrictions *AccessRestrictions `json:"access_restrictions,omitempty"`
|
||||
Auth ServiceAuthConfig `json:"auth"`
|
||||
|
||||
// Domain Domain for the service
|
||||
Domain string `json:"domain"`
|
||||
@@ -3537,8 +3641,14 @@ type Service struct {
|
||||
Enabled bool `json:"enabled"`
|
||||
|
||||
// Id Service ID
|
||||
Id string `json:"id"`
|
||||
Meta ServiceMeta `json:"meta"`
|
||||
Id string `json:"id"`
|
||||
|
||||
// ListenPort Port the proxy listens on (L4/TLS only)
|
||||
ListenPort *int `json:"listen_port,omitempty"`
|
||||
Meta ServiceMeta `json:"meta"`
|
||||
|
||||
// Mode Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
Mode *ServiceMode `json:"mode,omitempty"`
|
||||
|
||||
// Name Service name
|
||||
Name string `json:"name"`
|
||||
@@ -3546,6 +3656,9 @@ type Service struct {
|
||||
// PassHostHeader When true, the original client Host header is passed through to the backend instead of being rewritten to the backend's address
|
||||
PassHostHeader *bool `json:"pass_host_header,omitempty"`
|
||||
|
||||
// PortAutoAssigned Whether the listen port was auto-assigned
|
||||
PortAutoAssigned *bool `json:"port_auto_assigned,omitempty"`
|
||||
|
||||
// ProxyCluster The proxy cluster handling this service (derived from domain)
|
||||
ProxyCluster *string `json:"proxy_cluster,omitempty"`
|
||||
|
||||
@@ -3556,9 +3669,13 @@ type Service struct {
|
||||
Targets []ServiceTarget `json:"targets"`
|
||||
}
|
||||
|
||||
// ServiceMode Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
type ServiceMode string
|
||||
|
||||
// ServiceAuthConfig defines model for ServiceAuthConfig.
|
||||
type ServiceAuthConfig struct {
|
||||
BearerAuth *BearerAuthConfig `json:"bearer_auth,omitempty"`
|
||||
HeaderAuths *[]HeaderAuthConfig `json:"header_auths,omitempty"`
|
||||
LinkAuth *LinkAuthConfig `json:"link_auth,omitempty"`
|
||||
PasswordAuth *PasswordAuthConfig `json:"password_auth,omitempty"`
|
||||
PinAuth *PINAuthConfig `json:"pin_auth,omitempty"`
|
||||
@@ -3581,7 +3698,9 @@ type ServiceMetaStatus string
|
||||
|
||||
// ServiceRequest defines model for ServiceRequest.
|
||||
type ServiceRequest struct {
|
||||
Auth ServiceAuthConfig `json:"auth"`
|
||||
// AccessRestrictions Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
|
||||
AccessRestrictions *AccessRestrictions `json:"access_restrictions,omitempty"`
|
||||
Auth *ServiceAuthConfig `json:"auth,omitempty"`
|
||||
|
||||
// Domain Domain for the service
|
||||
Domain string `json:"domain"`
|
||||
@@ -3589,6 +3708,12 @@ type ServiceRequest struct {
|
||||
// Enabled Whether the service is enabled
|
||||
Enabled bool `json:"enabled"`
|
||||
|
||||
// ListenPort Port the proxy listens on (L4/TLS only). Set to 0 for auto-assignment.
|
||||
ListenPort *int `json:"listen_port,omitempty"`
|
||||
|
||||
// Mode Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
Mode *ServiceRequestMode `json:"mode,omitempty"`
|
||||
|
||||
// Name Service name
|
||||
Name string `json:"name"`
|
||||
|
||||
@@ -3599,9 +3724,12 @@ type ServiceRequest struct {
|
||||
RewriteRedirects *bool `json:"rewrite_redirects,omitempty"`
|
||||
|
||||
// Targets List of target backends for this service
|
||||
Targets []ServiceTarget `json:"targets"`
|
||||
Targets *[]ServiceTarget `json:"targets,omitempty"`
|
||||
}
|
||||
|
||||
// ServiceRequestMode Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
|
||||
type ServiceRequestMode string
|
||||
|
||||
// ServiceTarget defines model for ServiceTarget.
|
||||
type ServiceTarget struct {
|
||||
// Enabled Whether this target is enabled
|
||||
@@ -3611,10 +3739,10 @@ type ServiceTarget struct {
|
||||
Host *string `json:"host,omitempty"`
|
||||
Options *ServiceTargetOptions `json:"options,omitempty"`
|
||||
|
||||
// Path URL path prefix for this target
|
||||
// Path URL path prefix for this target (HTTP only)
|
||||
Path *string `json:"path,omitempty"`
|
||||
|
||||
// Port Backend port for this target. Use 0 or omit to use the scheme default (80 for http, 443 for https).
|
||||
// Port Backend port for this target
|
||||
Port int `json:"port"`
|
||||
|
||||
// Protocol Protocol to use when connecting to the backend
|
||||
@@ -3623,14 +3751,14 @@ type ServiceTarget struct {
|
||||
// TargetId Target ID
|
||||
TargetId string `json:"target_id"`
|
||||
|
||||
// TargetType Target type (e.g., "peer", "resource")
|
||||
// TargetType Target type
|
||||
TargetType ServiceTargetTargetType `json:"target_type"`
|
||||
}
|
||||
|
||||
// ServiceTargetProtocol Protocol to use when connecting to the backend
|
||||
type ServiceTargetProtocol string
|
||||
|
||||
// ServiceTargetTargetType Target type (e.g., "peer", "resource")
|
||||
// ServiceTargetTargetType Target type
|
||||
type ServiceTargetTargetType string
|
||||
|
||||
// ServiceTargetOptions defines model for ServiceTargetOptions.
|
||||
@@ -3641,9 +3769,15 @@ type ServiceTargetOptions struct {
|
||||
// PathRewrite Controls how the request path is rewritten before forwarding to the backend. Default strips the matched prefix. "preserve" keeps the full original request path.
|
||||
PathRewrite *ServiceTargetOptionsPathRewrite `json:"path_rewrite,omitempty"`
|
||||
|
||||
// ProxyProtocol Send PROXY Protocol v2 header to this backend (TCP/TLS only)
|
||||
ProxyProtocol *bool `json:"proxy_protocol,omitempty"`
|
||||
|
||||
// RequestTimeout Per-target response timeout as a Go duration string (e.g. "30s", "2m")
|
||||
RequestTimeout *string `json:"request_timeout,omitempty"`
|
||||
|
||||
// SessionIdleTimeout Idle timeout before a UDP session is reaped, as a Go duration string (e.g. "30s", "2m").
|
||||
SessionIdleTimeout *string `json:"session_idle_timeout,omitempty"`
|
||||
|
||||
// SkipTlsVerify Skip TLS certificate verification for this backend
|
||||
SkipTlsVerify *bool `json:"skip_tls_verify,omitempty"`
|
||||
}
|
||||
@@ -4168,6 +4302,9 @@ type ZoneRequest struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// Conflict Standard error response. Note: The exact structure of this error response is inferred from `util.WriteErrorResponse` and `util.WriteError` usage in the provided Go code, as a specific Go struct for errors was not provided.
|
||||
type Conflict = ErrorResponse
|
||||
|
||||
// GetApiEventsNetworkTrafficParams defines parameters for GetApiEventsNetworkTraffic.
|
||||
type GetApiEventsNetworkTrafficParams struct {
|
||||
// Page Page number
|
||||
|
||||
Reference in New Issue
Block a user