mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-20 17:26:40 +00:00
update openapi specs
This commit is contained in:
@@ -36,8 +36,8 @@ tags:
|
|||||||
x-cloud-only: true
|
x-cloud-only: true
|
||||||
- name: Identity Providers
|
- name: Identity Providers
|
||||||
description: Interact with and view information about identity providers.
|
description: Interact with and view information about identity providers.
|
||||||
- name: Services
|
- name: Reverse Proxy
|
||||||
description: Interact with and view information about exposed services.
|
description: Interact with and view information about reverse proxies.
|
||||||
- name: Instance
|
- name: Instance
|
||||||
description: Instance setup and status endpoints for initial configuration.
|
description: Instance setup and status endpoints for initial configuration.
|
||||||
components:
|
components:
|
||||||
@@ -2431,145 +2431,154 @@ components:
|
|||||||
- issuer
|
- issuer
|
||||||
- client_id
|
- client_id
|
||||||
- client_secret
|
- client_secret
|
||||||
Service:
|
ReverseProxy:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Service ID
|
description: Reverse proxy ID
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Service name
|
description: Reverse proxy name
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
description: Service description
|
|
||||||
domain:
|
domain:
|
||||||
type: string
|
type: string
|
||||||
description: Domain for the service
|
description: Domain for the reverse proxy
|
||||||
targets:
|
targets:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/ServiceTarget'
|
$ref: '#/components/schemas/ReverseProxyTarget'
|
||||||
description: List of target backends for this service
|
description: List of target backends for this reverse proxy
|
||||||
distribution_groups:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: List of group IDs that can access this service
|
|
||||||
enabled:
|
enabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether the service is enabled
|
description: Whether the reverse proxy is enabled
|
||||||
exposed:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the service is exposed
|
|
||||||
auth:
|
auth:
|
||||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
$ref: '#/components/schemas/ReverseProxyAuthConfig'
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- name
|
- name
|
||||||
- domain
|
- domain
|
||||||
- targets
|
- targets
|
||||||
- distribution_groups
|
|
||||||
- enabled
|
- enabled
|
||||||
- exposed
|
- auth
|
||||||
ServiceRequest:
|
ReverseProxyRequest:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
description: Service name
|
description: Reverse proxy name
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
description: Service description
|
|
||||||
domain:
|
domain:
|
||||||
type: string
|
type: string
|
||||||
description: Domain for the service
|
description: Domain for the reverse proxy
|
||||||
targets:
|
targets:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/ServiceTarget'
|
$ref: '#/components/schemas/ReverseProxyTarget'
|
||||||
description: List of target backends for this service
|
description: List of target backends for this reverse proxy
|
||||||
distribution_groups:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: List of group IDs that can access this service
|
|
||||||
enabled:
|
enabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether the service is enabled
|
description: Whether the reverse proxy is enabled
|
||||||
default: true
|
default: true
|
||||||
exposed:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the service is exposed
|
|
||||||
default: false
|
|
||||||
auth:
|
auth:
|
||||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
$ref: '#/components/schemas/ReverseProxyAuthConfig'
|
||||||
required:
|
required:
|
||||||
- name
|
- name
|
||||||
- domain
|
- domain
|
||||||
- targets
|
- targets
|
||||||
- distribution_groups
|
- auth
|
||||||
ServiceTarget:
|
- enabled
|
||||||
|
ReverseProxyTarget:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
target_id:
|
||||||
|
type: string
|
||||||
|
description: Target ID
|
||||||
|
target_type:
|
||||||
|
type: string
|
||||||
|
description: Target type (e.g., "peer", "resource")
|
||||||
|
enum: [peer, resource]
|
||||||
path:
|
path:
|
||||||
type: string
|
type: string
|
||||||
description: URL path prefix for this target
|
description: URL path prefix for this target
|
||||||
|
protocol:
|
||||||
|
type: string
|
||||||
|
description: Protocol to use when connecting to the backend
|
||||||
|
enum: [http, https]
|
||||||
host:
|
host:
|
||||||
type: string
|
type: string
|
||||||
description: Backend host:port for this target
|
description: Backend ip or domain for this target
|
||||||
|
port:
|
||||||
|
type: integer
|
||||||
|
description: Backend port for this target
|
||||||
enabled:
|
enabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether this target is enabled
|
description: Whether this target is enabled
|
||||||
required:
|
required:
|
||||||
- path
|
- target_id
|
||||||
|
- target_type
|
||||||
|
- protocol
|
||||||
- host
|
- host
|
||||||
|
- port
|
||||||
- enabled
|
- enabled
|
||||||
ServiceAuthConfig:
|
ReverseProxyAuthConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
enum: [basic, pin, bearer]
|
enum: [password, pin, bearer, link]
|
||||||
description: Authentication type
|
description: Authentication type
|
||||||
basic_auth:
|
password_auth:
|
||||||
$ref: '#/components/schemas/BasicAuthConfig'
|
$ref: '#/components/schemas/PasswordAuthConfig'
|
||||||
pin_auth:
|
pin_auth:
|
||||||
$ref: '#/components/schemas/PINAuthConfig'
|
$ref: '#/components/schemas/PINAuthConfig'
|
||||||
bearer_auth:
|
bearer_auth:
|
||||||
$ref: '#/components/schemas/BearerAuthConfig'
|
$ref: '#/components/schemas/BearerAuthConfig'
|
||||||
|
link_auth:
|
||||||
|
$ref: '#/components/schemas/LinkAuthConfig'
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
BasicAuthConfig:
|
PasswordAuthConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
username:
|
enabled:
|
||||||
type: string
|
type: boolean
|
||||||
description: Basic auth username
|
description: Whether password auth is enabled
|
||||||
password:
|
password:
|
||||||
type: string
|
type: string
|
||||||
description: Basic auth password
|
description: Auth password
|
||||||
required:
|
required:
|
||||||
- username
|
- enabled
|
||||||
- password
|
- password
|
||||||
PINAuthConfig:
|
PINAuthConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
enabled:
|
||||||
|
type: boolean
|
||||||
|
description: Whether PIN auth is enabled
|
||||||
pin:
|
pin:
|
||||||
type: string
|
type: string
|
||||||
description: PIN value
|
description: PIN value
|
||||||
header:
|
|
||||||
type: string
|
|
||||||
description: HTTP header name for PIN
|
|
||||||
required:
|
required:
|
||||||
|
- enabled
|
||||||
- pin
|
- pin
|
||||||
- header
|
|
||||||
BearerAuthConfig:
|
BearerAuthConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
enabled:
|
enabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether bearer auth is enabled
|
description: Whether bearer auth is enabled
|
||||||
|
distribution_groups:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: List of group IDs that can use bearer auth
|
||||||
|
required:
|
||||||
|
- enabled
|
||||||
|
LinkAuthConfig:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
enabled:
|
||||||
|
type: boolean
|
||||||
|
description: Whether link auth is enabled
|
||||||
required:
|
required:
|
||||||
- enabled
|
- enabled
|
||||||
InstanceStatus:
|
InstanceStatus:
|
||||||
@@ -5773,23 +5782,23 @@ paths:
|
|||||||
"$ref": "#/components/responses/forbidden"
|
"$ref": "#/components/responses/forbidden"
|
||||||
'500':
|
'500':
|
||||||
"$ref": "#/components/responses/internal_error"
|
"$ref": "#/components/responses/internal_error"
|
||||||
/api/services:
|
/api/reverse-proxy:
|
||||||
get:
|
get:
|
||||||
summary: List all Services
|
summary: List all Reverse Proxies
|
||||||
description: Returns a list of all exposed services
|
description: Returns a list of all reverse proxies
|
||||||
tags: [ Services ]
|
tags: [ Reverse Proxy ]
|
||||||
security:
|
security:
|
||||||
- BearerAuth: [ ]
|
- BearerAuth: [ ]
|
||||||
- TokenAuth: [ ]
|
- TokenAuth: [ ]
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: A JSON Array of Services
|
description: A JSON Array of reverse proxies
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Service'
|
$ref: '#/components/schemas/ReverseProxy'
|
||||||
'401':
|
'401':
|
||||||
"$ref": "#/components/responses/requires_authentication"
|
"$ref": "#/components/responses/requires_authentication"
|
||||||
'403':
|
'403':
|
||||||
@@ -5797,25 +5806,25 @@ paths:
|
|||||||
'500':
|
'500':
|
||||||
"$ref": "#/components/responses/internal_error"
|
"$ref": "#/components/responses/internal_error"
|
||||||
post:
|
post:
|
||||||
summary: Create a Service
|
summary: Create a Reverse Proxy
|
||||||
description: Creates a new exposed service
|
description: Creates a new reverse proxy
|
||||||
tags: [ Services ]
|
tags: [ Reverse Proxy ]
|
||||||
security:
|
security:
|
||||||
- BearerAuth: [ ]
|
- BearerAuth: [ ]
|
||||||
- TokenAuth: [ ]
|
- TokenAuth: [ ]
|
||||||
requestBody:
|
requestBody:
|
||||||
description: New service request
|
description: New reverse proxy request
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ServiceRequest'
|
$ref: '#/components/schemas/ReverseProxyRequest'
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Service created
|
description: Reverse proxy created
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Service'
|
$ref: '#/components/schemas/ReverseProxy'
|
||||||
'400':
|
'400':
|
||||||
"$ref": "#/components/responses/bad_request"
|
"$ref": "#/components/responses/bad_request"
|
||||||
'401':
|
'401':
|
||||||
@@ -5824,28 +5833,28 @@ paths:
|
|||||||
"$ref": "#/components/responses/forbidden"
|
"$ref": "#/components/responses/forbidden"
|
||||||
'500':
|
'500':
|
||||||
"$ref": "#/components/responses/internal_error"
|
"$ref": "#/components/responses/internal_error"
|
||||||
/api/services/{serviceId}:
|
/api/reverse-proxy/{proxyId}:
|
||||||
get:
|
get:
|
||||||
summary: Retrieve a Service
|
summary: Retrieve a Reverse Proxy
|
||||||
description: Get information about a specific service
|
description: Get information about a specific reverse proxy
|
||||||
tags: [ Services ]
|
tags: [ Reverse Proxy ]
|
||||||
security:
|
security:
|
||||||
- BearerAuth: [ ]
|
- BearerAuth: [ ]
|
||||||
- TokenAuth: [ ]
|
- TokenAuth: [ ]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: serviceId
|
name: proxyId
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: The unique identifier of a service
|
description: The unique identifier of a reverse proxy
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: A Service object
|
description: A reverse proxy object
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Service'
|
$ref: '#/components/schemas/ReverseProxy'
|
||||||
'400':
|
'400':
|
||||||
"$ref": "#/components/responses/bad_request"
|
"$ref": "#/components/responses/bad_request"
|
||||||
'401':
|
'401':
|
||||||
@@ -5857,32 +5866,32 @@ paths:
|
|||||||
'500':
|
'500':
|
||||||
"$ref": "#/components/responses/internal_error"
|
"$ref": "#/components/responses/internal_error"
|
||||||
put:
|
put:
|
||||||
summary: Update a Service
|
summary: Update a Reverse Proxy
|
||||||
description: Update an existing service configuration
|
description: Update an existing reverse proxy
|
||||||
tags: [ Services ]
|
tags: [ Reverse Proxy ]
|
||||||
security:
|
security:
|
||||||
- BearerAuth: [ ]
|
- BearerAuth: [ ]
|
||||||
- TokenAuth: [ ]
|
- TokenAuth: [ ]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: serviceId
|
name: proxyId
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: The unique identifier of a service
|
description: The unique identifier of a reverse proxy
|
||||||
requestBody:
|
requestBody:
|
||||||
description: Service update request
|
description: Reverse proxy update request
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ServiceRequest'
|
$ref: '#/components/schemas/ReverseProxyRequest'
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Service updated
|
description: Reverse proxy updated
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Service'
|
$ref: '#/components/schemas/ReverseProxy'
|
||||||
'400':
|
'400':
|
||||||
"$ref": "#/components/responses/bad_request"
|
"$ref": "#/components/responses/bad_request"
|
||||||
'401':
|
'401':
|
||||||
@@ -5894,22 +5903,22 @@ paths:
|
|||||||
'500':
|
'500':
|
||||||
"$ref": "#/components/responses/internal_error"
|
"$ref": "#/components/responses/internal_error"
|
||||||
delete:
|
delete:
|
||||||
summary: Delete a Service
|
summary: Delete a Reverse Proxy
|
||||||
description: Delete an existing service
|
description: Delete an existing reverse proxy
|
||||||
tags: [ Services ]
|
tags: [ Reverse Proxy ]
|
||||||
security:
|
security:
|
||||||
- BearerAuth: [ ]
|
- BearerAuth: [ ]
|
||||||
- TokenAuth: [ ]
|
- TokenAuth: [ ]
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: serviceId
|
name: proxyId
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: The unique identifier of a service
|
description: The unique identifier of a reverse proxy
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Service deleted
|
description: Reverse proxy deleted
|
||||||
'400':
|
'400':
|
||||||
"$ref": "#/components/responses/bad_request"
|
"$ref": "#/components/responses/bad_request"
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -49,6 +49,9 @@ const (
|
|||||||
EventActivityCodeRuleAdd EventActivityCode = "rule.add"
|
EventActivityCodeRuleAdd EventActivityCode = "rule.add"
|
||||||
EventActivityCodeRuleDelete EventActivityCode = "rule.delete"
|
EventActivityCodeRuleDelete EventActivityCode = "rule.delete"
|
||||||
EventActivityCodeRuleUpdate EventActivityCode = "rule.update"
|
EventActivityCodeRuleUpdate EventActivityCode = "rule.update"
|
||||||
|
EventActivityCodeServiceCreate EventActivityCode = "service.create"
|
||||||
|
EventActivityCodeServiceDelete EventActivityCode = "service.delete"
|
||||||
|
EventActivityCodeServiceUpdate EventActivityCode = "service.update"
|
||||||
EventActivityCodeServiceUserCreate EventActivityCode = "service.user.create"
|
EventActivityCodeServiceUserCreate EventActivityCode = "service.user.create"
|
||||||
EventActivityCodeServiceUserDelete EventActivityCode = "service.user.delete"
|
EventActivityCodeServiceUserDelete EventActivityCode = "service.user.delete"
|
||||||
EventActivityCodeSetupkeyAdd EventActivityCode = "setupkey.add"
|
EventActivityCodeSetupkeyAdd EventActivityCode = "setupkey.add"
|
||||||
@@ -193,11 +196,24 @@ const (
|
|||||||
ResourceTypeSubnet ResourceType = "subnet"
|
ResourceTypeSubnet ResourceType = "subnet"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Defines values for ServiceAuthConfigType.
|
// Defines values for ReverseProxyAuthConfigType.
|
||||||
const (
|
const (
|
||||||
ServiceAuthConfigTypeBasic ServiceAuthConfigType = "basic"
|
ReverseProxyAuthConfigTypeBearer ReverseProxyAuthConfigType = "bearer"
|
||||||
ServiceAuthConfigTypeBearer ServiceAuthConfigType = "bearer"
|
ReverseProxyAuthConfigTypeLink ReverseProxyAuthConfigType = "link"
|
||||||
ServiceAuthConfigTypePin ServiceAuthConfigType = "pin"
|
ReverseProxyAuthConfigTypePassword ReverseProxyAuthConfigType = "password"
|
||||||
|
ReverseProxyAuthConfigTypePin ReverseProxyAuthConfigType = "pin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Defines values for ReverseProxyTargetProtocol.
|
||||||
|
const (
|
||||||
|
ReverseProxyTargetProtocolHttp ReverseProxyTargetProtocol = "http"
|
||||||
|
ReverseProxyTargetProtocolHttps ReverseProxyTargetProtocol = "https"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Defines values for ReverseProxyTargetTargetType.
|
||||||
|
const (
|
||||||
|
ReverseProxyTargetTargetTypePeer ReverseProxyTargetTargetType = "peer"
|
||||||
|
ReverseProxyTargetTargetTypeResource ReverseProxyTargetTargetType = "resource"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Defines values for UserStatus.
|
// Defines values for UserStatus.
|
||||||
@@ -375,17 +391,11 @@ type AvailablePorts struct {
|
|||||||
Udp int `json:"udp"`
|
Udp int `json:"udp"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BasicAuthConfig defines model for BasicAuthConfig.
|
|
||||||
type BasicAuthConfig struct {
|
|
||||||
// Password Basic auth password
|
|
||||||
Password string `json:"password"`
|
|
||||||
|
|
||||||
// Username Basic auth username
|
|
||||||
Username string `json:"username"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// BearerAuthConfig defines model for BearerAuthConfig.
|
// BearerAuthConfig defines model for BearerAuthConfig.
|
||||||
type BearerAuthConfig struct {
|
type BearerAuthConfig struct {
|
||||||
|
// DistributionGroups List of group IDs that can use bearer auth
|
||||||
|
DistributionGroups *[]string `json:"distribution_groups,omitempty"`
|
||||||
|
|
||||||
// Enabled Whether bearer auth is enabled
|
// Enabled Whether bearer auth is enabled
|
||||||
Enabled bool `json:"enabled"`
|
Enabled bool `json:"enabled"`
|
||||||
}
|
}
|
||||||
@@ -777,6 +787,12 @@ type InstanceStatus struct {
|
|||||||
SetupRequired bool `json:"setup_required"`
|
SetupRequired bool `json:"setup_required"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// LinkAuthConfig defines model for LinkAuthConfig.
|
||||||
|
type LinkAuthConfig struct {
|
||||||
|
// Enabled Whether link auth is enabled
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
}
|
||||||
|
|
||||||
// Location Describe geographical location information
|
// Location Describe geographical location information
|
||||||
type Location struct {
|
type Location struct {
|
||||||
// CityName Commonly used English name of the city
|
// CityName Commonly used English name of the city
|
||||||
@@ -1149,13 +1165,22 @@ type OSVersionCheck struct {
|
|||||||
|
|
||||||
// PINAuthConfig defines model for PINAuthConfig.
|
// PINAuthConfig defines model for PINAuthConfig.
|
||||||
type PINAuthConfig struct {
|
type PINAuthConfig struct {
|
||||||
// Header HTTP header name for PIN
|
// Enabled Whether PIN auth is enabled
|
||||||
Header string `json:"header"`
|
Enabled bool `json:"enabled"`
|
||||||
|
|
||||||
// Pin PIN value
|
// Pin PIN value
|
||||||
Pin string `json:"pin"`
|
Pin string `json:"pin"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PasswordAuthConfig defines model for PasswordAuthConfig.
|
||||||
|
type PasswordAuthConfig struct {
|
||||||
|
// Enabled Whether password auth is enabled
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
|
||||||
|
// Password Auth password
|
||||||
|
Password string `json:"password"`
|
||||||
|
}
|
||||||
|
|
||||||
// Peer defines model for Peer.
|
// Peer defines model for Peer.
|
||||||
type Peer struct {
|
type Peer struct {
|
||||||
// ApprovalRequired (Cloud only) Indicates whether peer needs approval
|
// ApprovalRequired (Cloud only) Indicates whether peer needs approval
|
||||||
@@ -1717,6 +1742,87 @@ type Resource struct {
|
|||||||
// ResourceType defines model for ResourceType.
|
// ResourceType defines model for ResourceType.
|
||||||
type ResourceType string
|
type ResourceType string
|
||||||
|
|
||||||
|
// ReverseProxy defines model for ReverseProxy.
|
||||||
|
type ReverseProxy struct {
|
||||||
|
Auth ReverseProxyAuthConfig `json:"auth"`
|
||||||
|
|
||||||
|
// Domain Domain for the reverse proxy
|
||||||
|
Domain string `json:"domain"`
|
||||||
|
|
||||||
|
// Enabled Whether the reverse proxy is enabled
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
|
||||||
|
// Id Reverse proxy ID
|
||||||
|
Id string `json:"id"`
|
||||||
|
|
||||||
|
// Name Reverse proxy name
|
||||||
|
Name string `json:"name"`
|
||||||
|
|
||||||
|
// Targets List of target backends for this reverse proxy
|
||||||
|
Targets []ReverseProxyTarget `json:"targets"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseProxyAuthConfig defines model for ReverseProxyAuthConfig.
|
||||||
|
type ReverseProxyAuthConfig struct {
|
||||||
|
BearerAuth *BearerAuthConfig `json:"bearer_auth,omitempty"`
|
||||||
|
LinkAuth *LinkAuthConfig `json:"link_auth,omitempty"`
|
||||||
|
PasswordAuth *PasswordAuthConfig `json:"password_auth,omitempty"`
|
||||||
|
PinAuth *PINAuthConfig `json:"pin_auth,omitempty"`
|
||||||
|
|
||||||
|
// Type Authentication type
|
||||||
|
Type ReverseProxyAuthConfigType `json:"type"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseProxyAuthConfigType Authentication type
|
||||||
|
type ReverseProxyAuthConfigType string
|
||||||
|
|
||||||
|
// ReverseProxyRequest defines model for ReverseProxyRequest.
|
||||||
|
type ReverseProxyRequest struct {
|
||||||
|
Auth ReverseProxyAuthConfig `json:"auth"`
|
||||||
|
|
||||||
|
// Domain Domain for the reverse proxy
|
||||||
|
Domain string `json:"domain"`
|
||||||
|
|
||||||
|
// Enabled Whether the reverse proxy is enabled
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
|
||||||
|
// Name Reverse proxy name
|
||||||
|
Name string `json:"name"`
|
||||||
|
|
||||||
|
// Targets List of target backends for this reverse proxy
|
||||||
|
Targets []ReverseProxyTarget `json:"targets"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseProxyTarget defines model for ReverseProxyTarget.
|
||||||
|
type ReverseProxyTarget struct {
|
||||||
|
// Enabled Whether this target is enabled
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
|
||||||
|
// Host Backend ip or domain for this target
|
||||||
|
Host string `json:"host"`
|
||||||
|
|
||||||
|
// Path URL path prefix for this target
|
||||||
|
Path *string `json:"path,omitempty"`
|
||||||
|
|
||||||
|
// Port Backend port for this target
|
||||||
|
Port int `json:"port"`
|
||||||
|
|
||||||
|
// Protocol Protocol to use when connecting to the backend
|
||||||
|
Protocol ReverseProxyTargetProtocol `json:"protocol"`
|
||||||
|
|
||||||
|
// TargetId Target ID
|
||||||
|
TargetId string `json:"target_id"`
|
||||||
|
|
||||||
|
// TargetType Target type (e.g., "peer", "resource")
|
||||||
|
TargetType ReverseProxyTargetTargetType `json:"target_type"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseProxyTargetProtocol Protocol to use when connecting to the backend
|
||||||
|
type ReverseProxyTargetProtocol string
|
||||||
|
|
||||||
|
// ReverseProxyTargetTargetType Target type (e.g., "peer", "resource")
|
||||||
|
type ReverseProxyTargetTargetType string
|
||||||
|
|
||||||
// Route defines model for Route.
|
// Route defines model for Route.
|
||||||
type Route struct {
|
type Route struct {
|
||||||
// AccessControlGroups Access control group identifier associated with route.
|
// AccessControlGroups Access control group identifier associated with route.
|
||||||
@@ -1816,86 +1922,6 @@ type RulePortRange struct {
|
|||||||
Start int `json:"start"`
|
Start int `json:"start"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Service defines model for Service.
|
|
||||||
type Service struct {
|
|
||||||
Auth *ServiceAuthConfig `json:"auth,omitempty"`
|
|
||||||
|
|
||||||
// Description Service description
|
|
||||||
Description *string `json:"description,omitempty"`
|
|
||||||
|
|
||||||
// DistributionGroups List of group IDs that can access this service
|
|
||||||
DistributionGroups []string `json:"distribution_groups"`
|
|
||||||
|
|
||||||
// Domain Domain for the service
|
|
||||||
Domain string `json:"domain"`
|
|
||||||
|
|
||||||
// Enabled Whether the service is enabled
|
|
||||||
Enabled bool `json:"enabled"`
|
|
||||||
|
|
||||||
// Exposed Whether the service is exposed
|
|
||||||
Exposed bool `json:"exposed"`
|
|
||||||
|
|
||||||
// Id Service ID
|
|
||||||
Id string `json:"id"`
|
|
||||||
|
|
||||||
// Name Service name
|
|
||||||
Name string `json:"name"`
|
|
||||||
|
|
||||||
// Targets List of target backends for this service
|
|
||||||
Targets []ServiceTarget `json:"targets"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServiceAuthConfig defines model for ServiceAuthConfig.
|
|
||||||
type ServiceAuthConfig struct {
|
|
||||||
BasicAuth *BasicAuthConfig `json:"basic_auth,omitempty"`
|
|
||||||
BearerAuth *BearerAuthConfig `json:"bearer_auth,omitempty"`
|
|
||||||
PinAuth *PINAuthConfig `json:"pin_auth,omitempty"`
|
|
||||||
|
|
||||||
// Type Authentication type
|
|
||||||
Type ServiceAuthConfigType `json:"type"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServiceAuthConfigType Authentication type
|
|
||||||
type ServiceAuthConfigType string
|
|
||||||
|
|
||||||
// ServiceRequest defines model for ServiceRequest.
|
|
||||||
type ServiceRequest struct {
|
|
||||||
Auth *ServiceAuthConfig `json:"auth,omitempty"`
|
|
||||||
|
|
||||||
// Description Service description
|
|
||||||
Description *string `json:"description,omitempty"`
|
|
||||||
|
|
||||||
// DistributionGroups List of group IDs that can access this service
|
|
||||||
DistributionGroups []string `json:"distribution_groups"`
|
|
||||||
|
|
||||||
// Domain Domain for the service
|
|
||||||
Domain string `json:"domain"`
|
|
||||||
|
|
||||||
// Enabled Whether the service is enabled
|
|
||||||
Enabled *bool `json:"enabled,omitempty"`
|
|
||||||
|
|
||||||
// Exposed Whether the service is exposed
|
|
||||||
Exposed *bool `json:"exposed,omitempty"`
|
|
||||||
|
|
||||||
// Name Service name
|
|
||||||
Name string `json:"name"`
|
|
||||||
|
|
||||||
// Targets List of target backends for this service
|
|
||||||
Targets []ServiceTarget `json:"targets"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServiceTarget defines model for ServiceTarget.
|
|
||||||
type ServiceTarget struct {
|
|
||||||
// Enabled Whether this target is enabled
|
|
||||||
Enabled bool `json:"enabled"`
|
|
||||||
|
|
||||||
// Host Backend host:port for this target
|
|
||||||
Host string `json:"host"`
|
|
||||||
|
|
||||||
// Path URL path prefix for this target
|
|
||||||
Path string `json:"path"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetupKey defines model for SetupKey.
|
// SetupKey defines model for SetupKey.
|
||||||
type SetupKey struct {
|
type SetupKey struct {
|
||||||
// AllowExtraDnsLabels Allow extra DNS labels to be added to the peer
|
// AllowExtraDnsLabels Allow extra DNS labels to be added to the peer
|
||||||
@@ -2351,18 +2377,18 @@ type PostApiPostureChecksJSONRequestBody = PostureCheckUpdate
|
|||||||
// PutApiPostureChecksPostureCheckIdJSONRequestBody defines body for PutApiPostureChecksPostureCheckId for application/json ContentType.
|
// PutApiPostureChecksPostureCheckIdJSONRequestBody defines body for PutApiPostureChecksPostureCheckId for application/json ContentType.
|
||||||
type PutApiPostureChecksPostureCheckIdJSONRequestBody = PostureCheckUpdate
|
type PutApiPostureChecksPostureCheckIdJSONRequestBody = PostureCheckUpdate
|
||||||
|
|
||||||
|
// PostApiReverseProxyJSONRequestBody defines body for PostApiReverseProxy for application/json ContentType.
|
||||||
|
type PostApiReverseProxyJSONRequestBody = ReverseProxyRequest
|
||||||
|
|
||||||
|
// PutApiReverseProxyProxyIdJSONRequestBody defines body for PutApiReverseProxyProxyId for application/json ContentType.
|
||||||
|
type PutApiReverseProxyProxyIdJSONRequestBody = ReverseProxyRequest
|
||||||
|
|
||||||
// PostApiRoutesJSONRequestBody defines body for PostApiRoutes for application/json ContentType.
|
// PostApiRoutesJSONRequestBody defines body for PostApiRoutes for application/json ContentType.
|
||||||
type PostApiRoutesJSONRequestBody = RouteRequest
|
type PostApiRoutesJSONRequestBody = RouteRequest
|
||||||
|
|
||||||
// PutApiRoutesRouteIdJSONRequestBody defines body for PutApiRoutesRouteId for application/json ContentType.
|
// PutApiRoutesRouteIdJSONRequestBody defines body for PutApiRoutesRouteId for application/json ContentType.
|
||||||
type PutApiRoutesRouteIdJSONRequestBody = RouteRequest
|
type PutApiRoutesRouteIdJSONRequestBody = RouteRequest
|
||||||
|
|
||||||
// PostApiServicesJSONRequestBody defines body for PostApiServices for application/json ContentType.
|
|
||||||
type PostApiServicesJSONRequestBody = ServiceRequest
|
|
||||||
|
|
||||||
// PutApiServicesServiceIdJSONRequestBody defines body for PutApiServicesServiceId for application/json ContentType.
|
|
||||||
type PutApiServicesServiceIdJSONRequestBody = ServiceRequest
|
|
||||||
|
|
||||||
// PostApiSetupJSONRequestBody defines body for PostApiSetup for application/json ContentType.
|
// PostApiSetupJSONRequestBody defines body for PostApiSetup for application/json ContentType.
|
||||||
type PostApiSetupJSONRequestBody = SetupRequest
|
type PostApiSetupJSONRequestBody = SetupRequest
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user