mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-27 20:56:44 +00:00
rename reverse proxy to services
This commit is contained in:
pascal
@@ -36,8 +36,8 @@ tags:
|
||||
x-cloud-only: true
|
||||
- name: Identity Providers
|
||||
description: Interact with and view information about identity providers.
|
||||
- name: Reverse Proxy
|
||||
description: Interact with and view information about reverse proxies.
|
||||
- name: Services
|
||||
description: Interact with and view information about reverse proxy services.
|
||||
- name: Instance
|
||||
description: Instance setup and status endpoints for initial configuration.
|
||||
- name: Jobs
|
||||
@@ -2711,9 +2711,9 @@ components:
|
||||
type: string
|
||||
description: "Unique identifier for the access log entry"
|
||||
example: "ch8i4ug6lnn4g9hqv7m0"
|
||||
proxy_id:
|
||||
service_id:
|
||||
type: string
|
||||
description: "ID of the reverse proxy that handled the request"
|
||||
description: "ID of the service that handled the request"
|
||||
example: "ch8i4ug6lnn4g9hqv7m0"
|
||||
timestamp:
|
||||
type: string
|
||||
@@ -2766,7 +2766,7 @@ components:
|
||||
example: "San Francisco"
|
||||
required:
|
||||
- id
|
||||
- proxy_id
|
||||
- service_id
|
||||
- timestamp
|
||||
- method
|
||||
- host
|
||||
@@ -2868,30 +2868,30 @@ components:
|
||||
- issuer
|
||||
- client_id
|
||||
- client_secret
|
||||
ReverseProxy:
|
||||
Service:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: Reverse proxy ID
|
||||
description: Service ID
|
||||
name:
|
||||
type: string
|
||||
description: Reverse proxy name
|
||||
description: Service name
|
||||
domain:
|
||||
type: string
|
||||
description: Domain for the reverse proxy
|
||||
description: Domain for the service
|
||||
proxy_cluster:
|
||||
type: string
|
||||
description: The proxy cluster handling this reverse proxy (derived from domain)
|
||||
description: The proxy cluster handling this service (derived from domain)
|
||||
example: "eu.proxy.netbird.io"
|
||||
targets:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ReverseProxyTarget'
|
||||
description: List of target backends for this reverse proxy
|
||||
$ref: '#/components/schemas/ServiceTarget'
|
||||
description: List of target backends for this service
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether the reverse proxy is enabled
|
||||
description: Whether the service is enabled
|
||||
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
|
||||
@@ -2899,9 +2899,9 @@ components:
|
||||
type: boolean
|
||||
description: When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
auth:
|
||||
$ref: '#/components/schemas/ReverseProxyAuthConfig'
|
||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
||||
meta:
|
||||
$ref: '#/components/schemas/ReverseProxyMeta'
|
||||
$ref: '#/components/schemas/ServiceMeta'
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
@@ -2910,13 +2910,13 @@ components:
|
||||
- enabled
|
||||
- auth
|
||||
- meta
|
||||
ReverseProxyMeta:
|
||||
ServiceMeta:
|
||||
type: object
|
||||
properties:
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the reverse proxy was created
|
||||
description: Timestamp when the service was created
|
||||
example: "2024-02-03T10:30:00Z"
|
||||
certificate_issued_at:
|
||||
type: string
|
||||
@@ -2932,28 +2932,28 @@ components:
|
||||
- certificate_pending
|
||||
- certificate_failed
|
||||
- error
|
||||
description: Current status of the reverse proxy
|
||||
description: Current status of the service
|
||||
example: "active"
|
||||
required:
|
||||
- created_at
|
||||
- status
|
||||
ReverseProxyRequest:
|
||||
ServiceRequest:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: Reverse proxy name
|
||||
description: Service name
|
||||
domain:
|
||||
type: string
|
||||
description: Domain for the reverse proxy
|
||||
description: Domain for the service
|
||||
targets:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ReverseProxyTarget'
|
||||
description: List of target backends for this reverse proxy
|
||||
$ref: '#/components/schemas/ServiceTarget'
|
||||
description: List of target backends for this service
|
||||
enabled:
|
||||
type: boolean
|
||||
description: Whether the reverse proxy is enabled
|
||||
description: Whether the service is enabled
|
||||
default: true
|
||||
pass_host_header:
|
||||
type: boolean
|
||||
@@ -2962,14 +2962,14 @@ components:
|
||||
type: boolean
|
||||
description: When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
auth:
|
||||
$ref: '#/components/schemas/ReverseProxyAuthConfig'
|
||||
$ref: '#/components/schemas/ServiceAuthConfig'
|
||||
required:
|
||||
- name
|
||||
- domain
|
||||
- targets
|
||||
- auth
|
||||
- enabled
|
||||
ReverseProxyTarget:
|
||||
ServiceTarget:
|
||||
type: object
|
||||
properties:
|
||||
target_id:
|
||||
@@ -3001,7 +3001,7 @@ components:
|
||||
- protocol
|
||||
- port
|
||||
- enabled
|
||||
ReverseProxyAuthConfig:
|
||||
ServiceAuthConfig:
|
||||
type: object
|
||||
properties:
|
||||
password_auth:
|
||||
@@ -6803,23 +6803,23 @@ paths:
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies:
|
||||
/api/reverse-proxies/services:
|
||||
get:
|
||||
summary: List all Reverse Proxies
|
||||
description: Returns a list of all reverse proxies
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: List all Services
|
||||
description: Returns a list of all reverse proxy services
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
responses:
|
||||
'200':
|
||||
description: A JSON Array of reverse proxies
|
||||
description: A JSON Array of services
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ReverseProxy'
|
||||
$ref: '#/components/schemas/Service'
|
||||
'401':
|
||||
"$ref": "#/components/responses/requires_authentication"
|
||||
'403':
|
||||
@@ -6827,25 +6827,25 @@ paths:
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
post:
|
||||
summary: Create a Reverse Proxy
|
||||
description: Creates a new reverse proxy
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: Create a Service
|
||||
description: Creates a new reverse proxy service
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
requestBody:
|
||||
description: New reverse proxy request
|
||||
description: New service request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxyRequest'
|
||||
$ref: '#/components/schemas/ServiceRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Reverse proxy created
|
||||
description: Service created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxy'
|
||||
$ref: '#/components/schemas/Service'
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -6858,7 +6858,7 @@ paths:
|
||||
get:
|
||||
summary: List available proxy clusters
|
||||
description: Returns a list of available proxy clusters with their connection status
|
||||
tags: [ Reverse Proxy ]
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
@@ -6877,28 +6877,28 @@ paths:
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/{proxyId}:
|
||||
/api/reverse-proxies/services/{serviceId}:
|
||||
get:
|
||||
summary: Retrieve a Reverse Proxy
|
||||
description: Get information about a specific reverse proxy
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: Retrieve a Service
|
||||
description: Get information about a specific reverse proxy service
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
parameters:
|
||||
- in: path
|
||||
name: proxyId
|
||||
name: serviceId
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The unique identifier of a reverse proxy
|
||||
description: The unique identifier of a service
|
||||
responses:
|
||||
'200':
|
||||
description: A reverse proxy object
|
||||
description: A service object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxy'
|
||||
$ref: '#/components/schemas/Service'
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -6910,32 +6910,32 @@ paths:
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
put:
|
||||
summary: Update a Reverse Proxy
|
||||
description: Update an existing reverse proxy
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: Update a Service
|
||||
description: Update an existing service
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
parameters:
|
||||
- in: path
|
||||
name: proxyId
|
||||
name: serviceId
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The unique identifier of a reverse proxy
|
||||
description: The unique identifier of a service
|
||||
requestBody:
|
||||
description: Reverse proxy update request
|
||||
description: Service update request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxyRequest'
|
||||
$ref: '#/components/schemas/ServiceRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Reverse proxy updated
|
||||
description: Service updated
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxy'
|
||||
$ref: '#/components/schemas/Service'
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -6947,22 +6947,22 @@ paths:
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
delete:
|
||||
summary: Delete a Reverse Proxy
|
||||
description: Delete an existing reverse proxy
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: Delete a Service
|
||||
description: Delete an existing service
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
parameters:
|
||||
- in: path
|
||||
name: proxyId
|
||||
name: serviceId
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The unique identifier of a reverse proxy
|
||||
description: The unique identifier of a service
|
||||
responses:
|
||||
'200':
|
||||
description: Reverse proxy deleted
|
||||
description: Service deleted
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -6975,9 +6975,9 @@ paths:
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/domains:
|
||||
get:
|
||||
summary: Retrieve Reverse Proxy Domains
|
||||
description: Get information about domains that can be used for Reverse Proxy endpoints.
|
||||
tags: [ Reverse Proxy ]
|
||||
summary: Retrieve Service Domains
|
||||
description: Get information about domains that can be used for service endpoints.
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
@@ -7002,8 +7002,8 @@ paths:
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
post:
|
||||
summary: Create a Custom domain
|
||||
description: Create a new Custom domain for use with Reverse Proxy endpoints, this will trigger an initial validation check
|
||||
tags: [ Reverse Proxy ]
|
||||
description: Create a new Custom domain for use with service endpoints, this will trigger an initial validation check
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
@@ -7015,11 +7015,11 @@ paths:
|
||||
$ref: '#/components/schemas/ReverseProxyDomainRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Reverse proxy created
|
||||
description: Service created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ReverseProxy'
|
||||
$ref: '#/components/schemas/Service'
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -7030,11 +7030,11 @@ paths:
|
||||
"$ref": "#/components/responses/not_found"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/domains/{domainId}:
|
||||
/api/services/domains/{domainId}:
|
||||
delete:
|
||||
summary: Delete a Custom domain
|
||||
description: Delete an existing reverse proxy custom domain
|
||||
tags: [ Reverse Proxy ]
|
||||
description: Delete an existing service custom domain
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
@@ -7047,7 +7047,7 @@ paths:
|
||||
description: The custom domain ID
|
||||
responses:
|
||||
'204':
|
||||
description: Reverse proxy custom domain deleted
|
||||
description: Service custom domain deleted
|
||||
'400':
|
||||
"$ref": "#/components/responses/bad_request"
|
||||
'401':
|
||||
@@ -7058,11 +7058,11 @@ paths:
|
||||
"$ref": "#/components/responses/not_found"
|
||||
'500':
|
||||
"$ref": "#/components/responses/internal_error"
|
||||
/api/reverse-proxies/domains/{domainId}/validate:
|
||||
/api/services/domains/{domainId}/validate:
|
||||
get:
|
||||
summary: Validate a custom domain
|
||||
description: Trigger domain ownership validation for a custom domain
|
||||
tags: [ Reverse Proxy ]
|
||||
tags: [ Services ]
|
||||
security:
|
||||
- BearerAuth: [ ]
|
||||
- TokenAuth: [ ]
|
||||
|
||||
@@ -275,26 +275,26 @@ const (
|
||||
ReverseProxyDomainTypeFree ReverseProxyDomainType = "free"
|
||||
)
|
||||
|
||||
// Defines values for ReverseProxyMetaStatus.
|
||||
// Defines values for ServiceMetaStatus.
|
||||
const (
|
||||
ReverseProxyMetaStatusActive ReverseProxyMetaStatus = "active"
|
||||
ReverseProxyMetaStatusCertificateFailed ReverseProxyMetaStatus = "certificate_failed"
|
||||
ReverseProxyMetaStatusCertificatePending ReverseProxyMetaStatus = "certificate_pending"
|
||||
ReverseProxyMetaStatusError ReverseProxyMetaStatus = "error"
|
||||
ReverseProxyMetaStatusPending ReverseProxyMetaStatus = "pending"
|
||||
ReverseProxyMetaStatusTunnelNotCreated ReverseProxyMetaStatus = "tunnel_not_created"
|
||||
ServiceMetaStatusActive ServiceMetaStatus = "active"
|
||||
ServiceMetaStatusCertificateFailed ServiceMetaStatus = "certificate_failed"
|
||||
ServiceMetaStatusCertificatePending ServiceMetaStatus = "certificate_pending"
|
||||
ServiceMetaStatusError ServiceMetaStatus = "error"
|
||||
ServiceMetaStatusPending ServiceMetaStatus = "pending"
|
||||
ServiceMetaStatusTunnelNotCreated ServiceMetaStatus = "tunnel_not_created"
|
||||
)
|
||||
|
||||
// Defines values for ReverseProxyTargetProtocol.
|
||||
// Defines values for ServiceTargetProtocol.
|
||||
const (
|
||||
ReverseProxyTargetProtocolHttp ReverseProxyTargetProtocol = "http"
|
||||
ReverseProxyTargetProtocolHttps ReverseProxyTargetProtocol = "https"
|
||||
ServiceTargetProtocolHttp ServiceTargetProtocol = "http"
|
||||
ServiceTargetProtocolHttps ServiceTargetProtocol = "https"
|
||||
)
|
||||
|
||||
// Defines values for ReverseProxyTargetTargetType.
|
||||
// Defines values for ServiceTargetTargetType.
|
||||
const (
|
||||
ReverseProxyTargetTargetTypePeer ReverseProxyTargetTargetType = "peer"
|
||||
ReverseProxyTargetTargetTypeResource ReverseProxyTargetTargetType = "resource"
|
||||
ServiceTargetTargetTypePeer ServiceTargetTargetType = "peer"
|
||||
ServiceTargetTargetTypeResource ServiceTargetTargetType = "resource"
|
||||
)
|
||||
|
||||
// Defines values for UserStatus.
|
||||
@@ -330,6 +330,23 @@ const (
|
||||
GetApiEventsNetworkTrafficParamsDirectionINGRESS GetApiEventsNetworkTrafficParamsDirection = "INGRESS"
|
||||
)
|
||||
|
||||
// Defines values for GetApiEventsProxyParamsMethod.
|
||||
const (
|
||||
GetApiEventsProxyParamsMethodDELETE GetApiEventsProxyParamsMethod = "DELETE"
|
||||
GetApiEventsProxyParamsMethodGET GetApiEventsProxyParamsMethod = "GET"
|
||||
GetApiEventsProxyParamsMethodHEAD GetApiEventsProxyParamsMethod = "HEAD"
|
||||
GetApiEventsProxyParamsMethodOPTIONS GetApiEventsProxyParamsMethod = "OPTIONS"
|
||||
GetApiEventsProxyParamsMethodPATCH GetApiEventsProxyParamsMethod = "PATCH"
|
||||
GetApiEventsProxyParamsMethodPOST GetApiEventsProxyParamsMethod = "POST"
|
||||
GetApiEventsProxyParamsMethodPUT GetApiEventsProxyParamsMethod = "PUT"
|
||||
)
|
||||
|
||||
// Defines values for GetApiEventsProxyParamsStatus.
|
||||
const (
|
||||
GetApiEventsProxyParamsStatusFailed GetApiEventsProxyParamsStatus = "failed"
|
||||
GetApiEventsProxyParamsStatusSuccess GetApiEventsProxyParamsStatus = "success"
|
||||
)
|
||||
|
||||
// AccessiblePeer defines model for AccessiblePeer.
|
||||
type AccessiblePeer struct {
|
||||
// CityName Commonly used English name of the city
|
||||
@@ -1931,12 +1948,12 @@ type ProxyAccessLog struct {
|
||||
// Path Path of the request
|
||||
Path string `json:"path"`
|
||||
|
||||
// ProxyId ID of the reverse proxy that handled the request
|
||||
ProxyId string `json:"proxy_id"`
|
||||
|
||||
// Reason Reason for the request result (e.g., authentication failure)
|
||||
Reason *string `json:"reason,omitempty"`
|
||||
|
||||
// ServiceId ID of the service that handled the request
|
||||
ServiceId string `json:"service_id"`
|
||||
|
||||
// SourceIp Source IP address of the request
|
||||
SourceIp *string `json:"source_ip,omitempty"`
|
||||
|
||||
@@ -1987,44 +2004,6 @@ type Resource struct {
|
||||
// ResourceType defines model for ResourceType.
|
||||
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"`
|
||||
Meta ReverseProxyMeta `json:"meta"`
|
||||
|
||||
// Name Reverse proxy name
|
||||
Name string `json:"name"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// ProxyCluster The proxy cluster handling this reverse proxy (derived from domain)
|
||||
ProxyCluster *string `json:"proxy_cluster,omitempty"`
|
||||
|
||||
// RewriteRedirects When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
RewriteRedirects *bool `json:"rewrite_redirects,omitempty"`
|
||||
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// ReverseProxyDomain defines model for ReverseProxyDomain.
|
||||
type ReverseProxyDomain struct {
|
||||
// Domain Domain name
|
||||
@@ -2055,74 +2034,6 @@ type ReverseProxyDomainRequest struct {
|
||||
// ReverseProxyDomainType Type of Reverse Proxy Domain
|
||||
type ReverseProxyDomainType string
|
||||
|
||||
// ReverseProxyMeta defines model for ReverseProxyMeta.
|
||||
type ReverseProxyMeta struct {
|
||||
// CertificateIssuedAt Timestamp when the certificate was issued (empty if not yet issued)
|
||||
CertificateIssuedAt *time.Time `json:"certificate_issued_at,omitempty"`
|
||||
|
||||
// CreatedAt Timestamp when the reverse proxy was created
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
|
||||
// Status Current status of the reverse proxy
|
||||
Status ReverseProxyMetaStatus `json:"status"`
|
||||
}
|
||||
|
||||
// ReverseProxyMetaStatus Current status of the reverse proxy
|
||||
type ReverseProxyMetaStatus 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"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// RewriteRedirects When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
RewriteRedirects *bool `json:"rewrite_redirects,omitempty"`
|
||||
|
||||
// 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,omitempty"`
|
||||
|
||||
// Path URL path prefix for this target
|
||||
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 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.
|
||||
type Route struct {
|
||||
// AccessControlGroups Access control group identifier associated with route.
|
||||
@@ -2222,6 +2133,112 @@ type RulePortRange struct {
|
||||
Start int `json:"start"`
|
||||
}
|
||||
|
||||
// Service defines model for Service.
|
||||
type Service struct {
|
||||
Auth ServiceAuthConfig `json:"auth"`
|
||||
|
||||
// Domain Domain for the service
|
||||
Domain string `json:"domain"`
|
||||
|
||||
// Enabled Whether the service is enabled
|
||||
Enabled bool `json:"enabled"`
|
||||
|
||||
// Id Service ID
|
||||
Id string `json:"id"`
|
||||
Meta ServiceMeta `json:"meta"`
|
||||
|
||||
// Name Service name
|
||||
Name string `json:"name"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// ProxyCluster The proxy cluster handling this service (derived from domain)
|
||||
ProxyCluster *string `json:"proxy_cluster,omitempty"`
|
||||
|
||||
// RewriteRedirects When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
RewriteRedirects *bool `json:"rewrite_redirects,omitempty"`
|
||||
|
||||
// Targets List of target backends for this service
|
||||
Targets []ServiceTarget `json:"targets"`
|
||||
}
|
||||
|
||||
// ServiceAuthConfig defines model for ServiceAuthConfig.
|
||||
type ServiceAuthConfig 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"`
|
||||
}
|
||||
|
||||
// ServiceMeta defines model for ServiceMeta.
|
||||
type ServiceMeta struct {
|
||||
// CertificateIssuedAt Timestamp when the certificate was issued (empty if not yet issued)
|
||||
CertificateIssuedAt *time.Time `json:"certificate_issued_at,omitempty"`
|
||||
|
||||
// CreatedAt Timestamp when the service was created
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
|
||||
// Status Current status of the service
|
||||
Status ServiceMetaStatus `json:"status"`
|
||||
}
|
||||
|
||||
// ServiceMetaStatus Current status of the service
|
||||
type ServiceMetaStatus string
|
||||
|
||||
// ServiceRequest defines model for ServiceRequest.
|
||||
type ServiceRequest struct {
|
||||
Auth ServiceAuthConfig `json:"auth"`
|
||||
|
||||
// Domain Domain for the service
|
||||
Domain string `json:"domain"`
|
||||
|
||||
// Enabled Whether the service is enabled
|
||||
Enabled bool `json:"enabled"`
|
||||
|
||||
// Name Service name
|
||||
Name string `json:"name"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// RewriteRedirects When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
|
||||
RewriteRedirects *bool `json:"rewrite_redirects,omitempty"`
|
||||
|
||||
// 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 ip or domain for this target
|
||||
Host *string `json:"host,omitempty"`
|
||||
|
||||
// Path URL path prefix for this target
|
||||
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 int `json:"port"`
|
||||
|
||||
// Protocol Protocol to use when connecting to the backend
|
||||
Protocol ServiceTargetProtocol `json:"protocol"`
|
||||
|
||||
// TargetId Target ID
|
||||
TargetId string `json:"target_id"`
|
||||
|
||||
// TargetType Target type (e.g., "peer", "resource")
|
||||
TargetType ServiceTargetTargetType `json:"target_type"`
|
||||
}
|
||||
|
||||
// ServiceTargetProtocol Protocol to use when connecting to the backend
|
||||
type ServiceTargetProtocol string
|
||||
|
||||
// ServiceTargetTargetType Target type (e.g., "peer", "resource")
|
||||
type ServiceTargetTargetType string
|
||||
|
||||
// SetupKey defines model for SetupKey.
|
||||
type SetupKey struct {
|
||||
// AllowExtraDnsLabels Allow extra DNS labels to be added to the peer
|
||||
@@ -2680,8 +2697,50 @@ type GetApiEventsProxyParams struct {
|
||||
|
||||
// PageSize Number of items per page (max 100)
|
||||
PageSize *int `form:"page_size,omitempty" json:"page_size,omitempty"`
|
||||
|
||||
// Search General search across request ID, host, path, source IP, user email, and user name
|
||||
Search *string `form:"search,omitempty" json:"search,omitempty"`
|
||||
|
||||
// SourceIp Filter by source IP address
|
||||
SourceIp *string `form:"source_ip,omitempty" json:"source_ip,omitempty"`
|
||||
|
||||
// Host Filter by host header
|
||||
Host *string `form:"host,omitempty" json:"host,omitempty"`
|
||||
|
||||
// Path Filter by request path (supports partial matching)
|
||||
Path *string `form:"path,omitempty" json:"path,omitempty"`
|
||||
|
||||
// UserId Filter by authenticated user ID
|
||||
UserId *string `form:"user_id,omitempty" json:"user_id,omitempty"`
|
||||
|
||||
// UserEmail Filter by user email (partial matching)
|
||||
UserEmail *string `form:"user_email,omitempty" json:"user_email,omitempty"`
|
||||
|
||||
// UserName Filter by user name (partial matching)
|
||||
UserName *string `form:"user_name,omitempty" json:"user_name,omitempty"`
|
||||
|
||||
// Method Filter by HTTP method
|
||||
Method *GetApiEventsProxyParamsMethod `form:"method,omitempty" json:"method,omitempty"`
|
||||
|
||||
// Status Filter by status (success = 2xx/3xx, failed = 1xx/4xx/5xx)
|
||||
Status *GetApiEventsProxyParamsStatus `form:"status,omitempty" json:"status,omitempty"`
|
||||
|
||||
// StatusCode Filter by HTTP status code
|
||||
StatusCode *int `form:"status_code,omitempty" json:"status_code,omitempty"`
|
||||
|
||||
// StartDate Filter by timestamp >= start_date (RFC3339 format)
|
||||
StartDate *time.Time `form:"start_date,omitempty" json:"start_date,omitempty"`
|
||||
|
||||
// EndDate Filter by timestamp <= end_date (RFC3339 format)
|
||||
EndDate *time.Time `form:"end_date,omitempty" json:"end_date,omitempty"`
|
||||
}
|
||||
|
||||
// GetApiEventsProxyParamsMethod defines parameters for GetApiEventsProxy.
|
||||
type GetApiEventsProxyParamsMethod string
|
||||
|
||||
// GetApiEventsProxyParamsStatus defines parameters for GetApiEventsProxy.
|
||||
type GetApiEventsProxyParamsStatus string
|
||||
|
||||
// GetApiGroupsParams defines parameters for GetApiGroups.
|
||||
type GetApiGroupsParams struct {
|
||||
// Name Filter groups by name (exact match)
|
||||
@@ -2796,14 +2855,14 @@ type PostApiPostureChecksJSONRequestBody = PostureCheckUpdate
|
||||
// PutApiPostureChecksPostureCheckIdJSONRequestBody defines body for PutApiPostureChecksPostureCheckId for application/json ContentType.
|
||||
type PutApiPostureChecksPostureCheckIdJSONRequestBody = PostureCheckUpdate
|
||||
|
||||
// PostApiReverseProxiesJSONRequestBody defines body for PostApiReverseProxies for application/json ContentType.
|
||||
type PostApiReverseProxiesJSONRequestBody = ReverseProxyRequest
|
||||
|
||||
// PostApiReverseProxiesDomainsJSONRequestBody defines body for PostApiReverseProxiesDomains for application/json ContentType.
|
||||
type PostApiReverseProxiesDomainsJSONRequestBody = ReverseProxyDomainRequest
|
||||
|
||||
// PutApiReverseProxiesProxyIdJSONRequestBody defines body for PutApiReverseProxiesProxyId for application/json ContentType.
|
||||
type PutApiReverseProxiesProxyIdJSONRequestBody = ReverseProxyRequest
|
||||
// PostApiReverseProxiesServicesJSONRequestBody defines body for PostApiReverseProxiesServices for application/json ContentType.
|
||||
type PostApiReverseProxiesServicesJSONRequestBody = ServiceRequest
|
||||
|
||||
// PutApiReverseProxiesServicesServiceIdJSONRequestBody defines body for PutApiReverseProxiesServicesServiceId for application/json ContentType.
|
||||
type PutApiReverseProxiesServicesServiceIdJSONRequestBody = ServiceRequest
|
||||
|
||||
// PostApiRoutesJSONRequestBody defines body for PostApiRoutes for application/json ContentType.
|
||||
type PostApiRoutesJSONRequestBody = RouteRequest
|
||||
|
||||
Reference in New Issue
Block a user