extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-06-20 17:58:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

[management] renamed ingress port endpoints (#3263)

Browse Source
This commit is contained in:
Pascal Fischer 2025-02-01 00:40:33 +01:00 committed by GitHub
parent a76ca8c565
commit 6344e34880
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 242 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
management/server/http/api/openapi.yml
View File

@ -29,8 +29,8 @@ tags:
description: View information about the account and network events. description: View information about the account and network events.
- name: Accounts - name: Accounts
description: View information about the accounts. description: View information about the accounts.
- name: Proxies - name: Ingress Peers
description: Interact with and view information about the proxy. description: Interact with and view information about the ingress peers.
x-cloud-only: true x-cloud-only: true
components: components:
schemas: schemas:
@ -1584,72 +1584,72 @@ components:
- initiator_email - initiator_email
- target_id - target_id
- meta - meta
ProxyCreateRequest: IngressPeerCreateRequest:
type: object type: object
properties: properties:
peer_id: peer_id:
description: ID of the peer that is used as a proxy description: ID of the peer that is used as an ingress peer
type: string type: string
example: ch8i4ug6lnn4g9hqv7m0 example: ch8i4ug6lnn4g9hqv7m0
enabled: enabled:
description: Defines if a proxy is enabled description: Defines if an ingress peer is enabled
type: boolean type: boolean
example: true example: true
fallback: fallback:
description: Defines if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer description: Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
type: boolean type: boolean
example: true example: true
required: required:
- peer_id - peer_id
- enabled - enabled
- fallback - fallback
ProxyUpdateRequest: IngressPeerUpdateRequest:
type: object type: object
properties: properties:
enabled: enabled:
description: Defines if a proxy is enabled description: Defines if an ingress peer is enabled
type: boolean type: boolean
example: true example: true
fallback: fallback:
description: Defines if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer description: Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
type: boolean type: boolean
example: true example: true
required: required:
- enabled - enabled
- fallback - fallback
Proxy: IngressPeer:
type: object type: object
properties: properties:
id: id:
description: ID of the proxy description: ID of the ingress peer
type: string type: string
example: ch8i4ug6lnn4g9hqv7m0 example: ch8i4ug6lnn4g9hqv7m0
peer_id: peer_id:
description: ID of the peer that is used as a proxy description: ID of the peer that is used as an ingress peer
type: string type: string
example: x7p3kqf2rdd8j5zxw4n9 example: x7p3kqf2rdd8j5zxw4n9
ingress_ip: ingress_ip:
description: Ingress IP address of the proxy where the traffic arrives description: Ingress IP address of the ingress peer where the traffic arrives
type: string type: string
example: 192.34.0.123 example: 192.34.0.123
available_ports: available_ports:
description: Number of available ports left on the proxy description: Number of available ports left on the ingress peer
type: integer type: integer
example: 45765 example: 45765
enabled: enabled:
description: Indicates if a proxy is enabled description: Indicates if an ingress peer is enabled
type: boolean type: boolean
example: true example: true
connected: connected:
description: Indicates if a proxy is connected to the management server description: Indicates if an ingress peer is connected to the management server
type: boolean type: boolean
example: true example: true
fallback: fallback:
description: Indicates if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer description: Indicates if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
type: boolean type: boolean
example: true example: true
region: region:
description: Region of the proxy description: Region of the ingress peer
type: string type: string
example: germany example: germany
required: required:
@ -1661,27 +1661,27 @@ components:
- connected - connected
- fallback - fallback
- region - region
ProxyConfigurationRequest: IngressPortAllocationRequest:
type: object type: object
properties: properties:
name: name:
description: Name of the proxy configuration description: Name of the ingress port allocation
type: string type: string
example: Proxy Configuration 1 example: Ingress Port Allocation 1
enabled: enabled:
description: Indicates if a proxy configuration is enabled description: Indicates if an ingress port allocation is enabled
type: boolean type: boolean
example: true example: true
port_ranges: port_ranges:
description: List of port ranges that are forwarded by the proxy description: List of port ranges that are forwarded by the ingress peer
type: array type: array
items: items:
$ref: '#/components/schemas/ProxyConfigurationRequestPortRange' $ref: '#/components/schemas/IngressPortAllocationRequestPortRange'
required: required:
- name - name
- enabled - enabled
- port_ranges - port_ranges
ProxyConfigurationRequestPortRange: IngressPortAllocationRequestPortRange:
type: object type: object
properties: properties:
start: start:
@ -1701,47 +1701,47 @@ components:
- start - start
- end - end
- protocol - protocol
ProxyConfiguration: IngressPortAllocation:
type: object type: object
properties: properties:
id: id:
description: ID of the proxy configuration description: ID of the ingress port allocation
type: string type: string
example: ch8i4ug6lnn4g9hqv7m0 example: ch8i4ug6lnn4g9hqv7m0
name: name:
description: Name of the proxy configuration description: Name of the ingress port allocation
type: string type: string
example: Proxy Configuration 1 example: Ingress Peer Allocation 1
proxy_id: ingress_peer_id:
description: ID of the proxy that forwards the ports description: ID of the ingress peer that forwards the ports
type: string type: string
example: x7p3kqf2rdd8j5zxw4n9 example: x7p3kqf2rdd8j5zxw4n9
region: region:
description: Region of the proxy description: Region of the ingress peer
type: string type: string
example: germany example: germany
enabled: enabled:
description: Indicates if a proxy configuration is enabled description: Indicates if an ingress port allocation is enabled
type: boolean type: boolean
example: true example: true
ingress_ip: ingress_ip:
description: Ingress IP address of the proxy where the traffic arrives description: Ingress IP address of the ingress peer where the traffic arrives
type: string type: string
example: example:
port_range_mappings: port_range_mappings:
description: List of port ranges that are allowed to be used by the proxy description: List of port ranges that are allowed to be used by the ingress peer
type: array type: array
items: items:
$ref: '#/components/schemas/ProxyConfigurationPortMapping' $ref: '#/components/schemas/IngressPortAllocationPortMapping'
required: required:
- id - id
- name - name
- proxy_id - ingress_peer_id
- region - region
- enabled - enabled
- ingress_ip - ingress_ip
- port_range_mappings - port_range_mappings
ProxyConfigurationPortMapping: IngressPortAllocationPortMapping:
type: object type: object
properties: properties:
translated_start: translated_start:
@ -2326,10 +2326,10 @@ paths:
"$ref": "#/components/responses/forbidden" "$ref": "#/components/responses/forbidden"
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/peers/{peerId}/proxy_configurations: /api/peers/{peerId}/ingress/ports:
get: get:
summary: List all Proxy Configurations summary: List all Ingress Port Allocations for a Peer
description: Returns a list of all proxy configurations for a peer description: Returns a list of all ingress port allocations for a peer
tags: [ Peers ] tags: [ Peers ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -2345,16 +2345,16 @@ paths:
name: name name: name
schema: schema:
type: string type: string
description: Filters proxy configurations by name description: Filters ingress port allocations by name
responses: responses:
'200': '200':
description: A JSON Array of Proxy Configurations description: A JSON Array of Ingress Port Allocations
content: content:
application/json: application/json:
schema: schema:
type: array type: array
items: items:
$ref: '#/components/schemas/ProxyConfiguration' $ref: '#/components/schemas/IngressPortAllocation'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2365,8 +2365,8 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
x-cloud-only: true x-cloud-only: true
summary: Create a Proxy Configuration summary: Create a Ingress Port Allocation
description: Creates a new proxy configuration for a peer description: Creates a new ingress port allocation for a peer
tags: [ Peers ] tags: [ Peers ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -2379,18 +2379,18 @@ paths:
type: string type: string
description: The unique identifier of a peer description: The unique identifier of a peer
requestBody: requestBody:
description: New Proxy Configuration request description: New Ingress Port Allocation request
content: content:
'application/json': 'application/json':
schema: schema:
$ref: '#/components/schemas/ProxyConfigurationRequest' $ref: '#/components/schemas/IngressPortAllocationRequest'
responses: responses:
'200': '200':
description: A Proxy Configuration object description: A Ingress Port Allocation object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ProxyConfiguration' $ref: '#/components/schemas/IngressPortAllocation'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2399,11 +2399,11 @@ paths:
"$ref": "#/components/responses/forbidden" "$ref": "#/components/responses/forbidden"
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/peers/{peerId}/proxy_configurations/{configurationId}: /api/peers/{peerId}/ingress/ports/{allocationId}:
get: get:
x-cloud-only: true x-cloud-only: true
summary: Retrieve a Proxy Configuration summary: Retrieve a Ingress Port Allocation
description: Get information about a proxy configuration description: Get information about an ingress port allocation
tags: [ Peers ] tags: [ Peers ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -2416,18 +2416,18 @@ paths:
type: string type: string
description: The unique identifier of a peer description: The unique identifier of a peer
- in: path - in: path
name: configurationId name: allocationId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy configuration description: The unique identifier of an ingress port allocation
responses: responses:
'200': '200':
description: A Proxy Configuration object description: A Ingress Port Allocation object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ProxyConfiguration' $ref: '#/components/schemas/IngressPortAllocation'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2446,24 +2446,24 @@ paths:
type: string type: string
description: The unique identifier of a peer description: The unique identifier of a peer
- in: path - in: path
name: configurationId name: allocationId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy configuration description: The unique identifier of an ingress port allocation
requestBody: requestBody:
description: update a proxy configuration description: update an ingress port allocation
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ProxyConfigurationRequest' $ref: '#/components/schemas/IngressPortAllocationRequest'
responses: responses:
'200': '200':
description: A Proxy Configuration object description: A Ingress Port Allocation object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ProxyConfiguration' $ref: '#/components/schemas/IngressPortAllocation'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2474,8 +2474,8 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
x-cloud-only: true x-cloud-only: true
summary: Delete a Proxy Configuration summary: Delete a Ingress Port Allocation
description: Delete a proxy configuration description: Delete an ingress port allocation
tags: [ Peers ] tags: [ Peers ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -2488,11 +2488,11 @@ paths:
type: string type: string
description: The unique identifier of a peer description: The unique identifier of a peer
- in: path - in: path
name: configurationId name: allocationId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy configuration description: The unique identifier of an ingress port allocation
responses: responses:
'200': '200':
description: Delete status code description: Delete status code
@ -2505,24 +2505,24 @@ paths:
"$ref": "#/components/responses/forbidden" "$ref": "#/components/responses/forbidden"
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/proxies: /api/ingress/peers:
get: get:
x-cloud-only: true x-cloud-only: true
summary: List all Proxies summary: List all Ingress Peers
description: Returns a list of all proxies description: Returns a list of all ingress peers
tags: [ Proxies ] tags: [ Proxies ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
responses: responses:
'200': '200':
description: A JSON Array of Proxies description: A JSON Array of Ingress Peers
content: content:
application/json: application/json:
schema: schema:
type: array type: array
items: items:
$ref: '#/components/schemas/Proxy' $ref: '#/components/schemas/IngressPeer'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2533,25 +2533,25 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
post: post:
x-cloud-only: true x-cloud-only: true
summary: Create a Proxy summary: Create a Ingress Peer
description: Creates a new proxy description: Creates a new ingress peer
tags: [ Proxies ] tags: [ Proxies ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
requestBody: requestBody:
description: New Proxy request description: New Ingress Peer request
content: content:
'application/json': 'application/json':
schema: schema:
$ref: '#/components/schemas/ProxyCreateRequest' $ref: '#/components/schemas/IngressPeerCreateRequest'
responses: responses:
'200': '200':
description: A Proxy object description: A Ingress Peer object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Proxy' $ref: '#/components/schemas/IngressPeer'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2560,29 +2560,29 @@ paths:
"$ref": "#/components/responses/forbidden" "$ref": "#/components/responses/forbidden"
'500': '500':
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
/api/proxies/{proxyId}: /api/ingress/peers/{ingressPeerId}:
get: get:
x-cloud-only: true x-cloud-only: true
summary: Retrieve a Proxy summary: Retrieve a Ingress Peer
description: Get information about a proxy description: Get information about an ingress peer
tags: [ Proxies ] tags: [ Proxies ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
parameters: parameters:
- in: path - in: path
name: proxyId name: ingressPeerId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy description: The unique identifier of an ingress peer
responses: responses:
'200': '200':
description: A Proxy object description: A Ingress Peer object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Proxy' $ref: '#/components/schemas/IngressPeer'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2593,32 +2593,32 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
put: put:
x-cloud-only: true x-cloud-only: true
summary: Update a Proxy summary: Update a Ingress Peer
description: Update information about a proxy description: Update information about an ingress peer
tags: [ Proxies ] tags: [ Proxies ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
parameters: parameters:
- in: path - in: path
name: proxyId name: ingressPeerId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy description: The unique identifier of an ingress peer
requestBody: requestBody:
description: update a proxy description: update an ingress peer
content: content:
'application/json': 'application/json':
schema: schema:
$ref: '#/components/schemas/ProxyUpdateRequest' $ref: '#/components/schemas/IngressPeerUpdateRequest'
responses: responses:
'200': '200':
description: A Proxy object description: A Ingress Peer object
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Proxy' $ref: '#/components/schemas/IngressPeer'
'400': '400':
"$ref": "#/components/responses/bad_request" "$ref": "#/components/responses/bad_request"
'401': '401':
@ -2629,19 +2629,19 @@ paths:
"$ref": "#/components/responses/internal_error" "$ref": "#/components/responses/internal_error"
delete: delete:
x-cloud-only: true x-cloud-only: true
summary: Delete a Proxy summary: Delete a Ingress Peer
description: Delete a proxy description: Delete an ingress peer
tags: [ Proxies ] tags: [ Proxies ]
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
- TokenAuth: [ ] - TokenAuth: [ ]
parameters: parameters:
- in: path - in: path
name: proxyId name: ingressPeerId
required: true required: true
schema: schema:
type: string type: string
description: The unique identifier of a proxy description: The unique identifier of an ingress peer
responses: responses:
'200': '200':
description: Delete status code description: Delete status code

290
management/server/http/api/types.gen.go
View File

@ -83,6 +83,18 @@ const (
GroupMinimumIssuedJwt GroupMinimumIssued = "jwt" GroupMinimumIssuedJwt GroupMinimumIssued = "jwt"
) )
// Defines values for IngressPortAllocationPortMappingProtocol.
const (
IngressPortAllocationPortMappingProtocolTcp IngressPortAllocationPortMappingProtocol = "tcp"
IngressPortAllocationPortMappingProtocolUdp IngressPortAllocationPortMappingProtocol = "udp"
)
// Defines values for IngressPortAllocationRequestPortRangeProtocol.
const (
IngressPortAllocationRequestPortRangeProtocolTcp IngressPortAllocationRequestPortRangeProtocol = "tcp"
IngressPortAllocationRequestPortRangeProtocolUdp IngressPortAllocationRequestPortRangeProtocol = "udp"
)
// Defines values for NameserverNsType. // Defines values for NameserverNsType.
const ( const (
NameserverNsTypeUdp NameserverNsType = "udp" NameserverNsTypeUdp NameserverNsType = "udp"
@ -143,18 +155,6 @@ const (
PolicyRuleUpdateProtocolUdp PolicyRuleUpdateProtocol = "udp" PolicyRuleUpdateProtocolUdp PolicyRuleUpdateProtocol = "udp"
) )
// Defines values for ProxyConfigurationPortMappingProtocol.
const (
ProxyConfigurationPortMappingProtocolTcp ProxyConfigurationPortMappingProtocol = "tcp"
ProxyConfigurationPortMappingProtocolUdp ProxyConfigurationPortMappingProtocol = "udp"
)
// Defines values for ProxyConfigurationRequestPortRangeProtocol.
const (
ProxyConfigurationRequestPortRangeProtocolTcp ProxyConfigurationRequestPortRangeProtocol = "tcp"
ProxyConfigurationRequestPortRangeProtocolUdp ProxyConfigurationRequestPortRangeProtocol = "udp"
)
// Defines values for ResourceType. // Defines values for ResourceType.
const ( const (
ResourceTypeDomain ResourceType = "domain" ResourceTypeDomain ResourceType = "domain"
@ -435,6 +435,126 @@ type GroupRequest struct {
Resources *[]Resource `json:"resources,omitempty"` Resources *[]Resource `json:"resources,omitempty"`
} }
// IngressPeer defines model for IngressPeer.
type IngressPeer struct {
// AvailablePorts Number of available ports left on the ingress peer
AvailablePorts int `json:"available_ports"`
// Connected Indicates if an ingress peer is connected to the management server
Connected bool `json:"connected"`
// Enabled Indicates if an ingress peer is enabled
Enabled bool `json:"enabled"`
// Fallback Indicates if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
// Id ID of the ingress peer
Id string `json:"id"`
// IngressIp Ingress IP address of the ingress peer where the traffic arrives
IngressIp string `json:"ingress_ip"`
// PeerId ID of the peer that is used as an ingress peer
PeerId string `json:"peer_id"`
// Region Region of the ingress peer
Region string `json:"region"`
}
// IngressPeerCreateRequest defines model for IngressPeerCreateRequest.
type IngressPeerCreateRequest struct {
// Enabled Defines if an ingress peer is enabled
Enabled bool `json:"enabled"`
// Fallback Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
// PeerId ID of the peer that is used as an ingress peer
PeerId string `json:"peer_id"`
}
// IngressPeerUpdateRequest defines model for IngressPeerUpdateRequest.
type IngressPeerUpdateRequest struct {
// Enabled Defines if an ingress peer is enabled
Enabled bool `json:"enabled"`
// Fallback Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
}
// IngressPortAllocation defines model for IngressPortAllocation.
type IngressPortAllocation struct {
// Enabled Indicates if an ingress port allocation is enabled
Enabled bool `json:"enabled"`
// Id ID of the ingress port allocation
Id string `json:"id"`
// IngressIp Ingress IP address of the ingress peer where the traffic arrives
IngressIp string `json:"ingress_ip"`
// IngressPeerId ID of the ingress peer that forwards the ports
IngressPeerId string `json:"ingress_peer_id"`
// Name Name of the ingress port allocation
Name string `json:"name"`
// PortRangeMappings List of port ranges that are allowed to be used by the ingress peer
PortRangeMappings []IngressPortAllocationPortMapping `json:"port_range_mappings"`
// Region Region of the ingress peer
Region string `json:"region"`
}
// IngressPortAllocationPortMapping defines model for IngressPortAllocationPortMapping.
type IngressPortAllocationPortMapping struct {
// IngressEnd The ending port of the range of ingress ports mapped to the forwarded ports
IngressEnd int `json:"ingress_end"`
// IngressStart The starting port of the range of ingress ports mapped to the forwarded ports
IngressStart int `json:"ingress_start"`
// Protocol Protocol accepted by the ports
Protocol IngressPortAllocationPortMappingProtocol `json:"protocol"`
// TranslatedEnd The ending port of the translated range of forwarded ports
TranslatedEnd int `json:"translated_end"`
// TranslatedStart The starting port of the translated range of forwarded ports
TranslatedStart int `json:"translated_start"`
}
// IngressPortAllocationPortMappingProtocol Protocol accepted by the ports
type IngressPortAllocationPortMappingProtocol string
// IngressPortAllocationRequest defines model for IngressPortAllocationRequest.
type IngressPortAllocationRequest struct {
// Enabled Indicates if an ingress port allocation is enabled
Enabled bool `json:"enabled"`
// Name Name of the ingress port allocation
Name string `json:"name"`
// PortRanges List of port ranges that are forwarded by the ingress peer
PortRanges []IngressPortAllocationRequestPortRange `json:"port_ranges"`
}
// IngressPortAllocationRequestPortRange defines model for IngressPortAllocationRequestPortRange.
type IngressPortAllocationRequestPortRange struct {
// End The ending port of the range of forwarded ports
End int `json:"end"`
// Protocol The protocol accepted by the port range
Protocol IngressPortAllocationRequestPortRangeProtocol `json:"protocol"`
// Start The starting port of the range of forwarded ports
Start int `json:"start"`
}
// IngressPortAllocationRequestPortRangeProtocol The protocol accepted by the port range
type IngressPortAllocationRequestPortRangeProtocol string
// 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
@ -1137,126 +1257,6 @@ type ProcessCheck struct {
Processes []Process `json:"processes"` Processes []Process `json:"processes"`
} }
// Proxy defines model for Proxy.
type Proxy struct {
// AvailablePorts Number of available ports left on the proxy
AvailablePorts int `json:"available_ports"`
// Connected Indicates if a proxy is connected to the management server
Connected bool `json:"connected"`
// Enabled Indicates if a proxy is enabled
Enabled bool `json:"enabled"`
// Fallback Indicates if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
// Id ID of the proxy
Id string `json:"id"`
// IngressIp Ingress IP address of the proxy where the traffic arrives
IngressIp string `json:"ingress_ip"`
// PeerId ID of the peer that is used as a proxy
PeerId string `json:"peer_id"`
// Region Region of the proxy
Region string `json:"region"`
}
// ProxyConfiguration defines model for ProxyConfiguration.
type ProxyConfiguration struct {
// Enabled Indicates if a proxy configuration is enabled
Enabled bool `json:"enabled"`
// Id ID of the proxy configuration
Id string `json:"id"`
// IngressIp Ingress IP address of the proxy where the traffic arrives
IngressIp string `json:"ingress_ip"`
// Name Name of the proxy configuration
Name string `json:"name"`
// PortRangeMappings List of port ranges that are allowed to be used by the proxy
PortRangeMappings []ProxyConfigurationPortMapping `json:"port_range_mappings"`
// ProxyId ID of the proxy that forwards the ports
ProxyId string `json:"proxy_id"`
// Region Region of the proxy
Region string `json:"region"`
}
// ProxyConfigurationPortMapping defines model for ProxyConfigurationPortMapping.
type ProxyConfigurationPortMapping struct {
// IngressEnd The ending port of the range of ingress ports mapped to the forwarded ports
IngressEnd int `json:"ingress_end"`
// IngressStart The starting port of the range of ingress ports mapped to the forwarded ports
IngressStart int `json:"ingress_start"`
// Protocol Protocol accepted by the ports
Protocol ProxyConfigurationPortMappingProtocol `json:"protocol"`
// TranslatedEnd The ending port of the translated range of forwarded ports
TranslatedEnd int `json:"translated_end"`
// TranslatedStart The starting port of the translated range of forwarded ports
TranslatedStart int `json:"translated_start"`
}
// ProxyConfigurationPortMappingProtocol Protocol accepted by the ports
type ProxyConfigurationPortMappingProtocol string
// ProxyConfigurationRequest defines model for ProxyConfigurationRequest.
type ProxyConfigurationRequest struct {
// Enabled Indicates if a proxy configuration is enabled
Enabled bool `json:"enabled"`
// Name Name of the proxy configuration
Name string `json:"name"`
// PortRanges List of port ranges that are forwarded by the proxy
PortRanges []ProxyConfigurationRequestPortRange `json:"port_ranges"`
}
// ProxyConfigurationRequestPortRange defines model for ProxyConfigurationRequestPortRange.
type ProxyConfigurationRequestPortRange struct {
// End The ending port of the range of forwarded ports
End int `json:"end"`
// Protocol The protocol accepted by the port range
Protocol ProxyConfigurationRequestPortRangeProtocol `json:"protocol"`
// Start The starting port of the range of forwarded ports
Start int `json:"start"`
}
// ProxyConfigurationRequestPortRangeProtocol The protocol accepted by the port range
type ProxyConfigurationRequestPortRangeProtocol string
// ProxyCreateRequest defines model for ProxyCreateRequest.
type ProxyCreateRequest struct {
// Enabled Defines if a proxy is enabled
Enabled bool `json:"enabled"`
// Fallback Defines if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
// PeerId ID of the peer that is used as a proxy
PeerId string `json:"peer_id"`
}
// ProxyUpdateRequest defines model for ProxyUpdateRequest.
type ProxyUpdateRequest struct {
// Enabled Defines if a proxy is enabled
Enabled bool `json:"enabled"`
// Fallback Defines if a proxy can be used as a fallback if no proxy can be found in the region of the forwarded peer
Fallback bool `json:"fallback"`
}
// Resource defines model for Resource. // Resource defines model for Resource.
type Resource struct { type Resource struct {
// Id ID of the resource // Id ID of the resource
@ -1580,9 +1580,9 @@ type UserRequest struct {
Role string `json:"role"` Role string `json:"role"`
} }
// GetApiPeersPeerIdProxyConfigurationsParams defines parameters for GetApiPeersPeerIdProxyConfigurations. // GetApiPeersPeerIdIngressPortsParams defines parameters for GetApiPeersPeerIdIngressPorts.
type GetApiPeersPeerIdProxyConfigurationsParams struct { type GetApiPeersPeerIdIngressPortsParams struct {
// Name Filters proxy configurations by name // Name Filters ingress port allocations by name
Name *string `form:"name,omitempty" json:"name,omitempty"` Name *string `form:"name,omitempty" json:"name,omitempty"`
} }
@ -1610,6 +1610,12 @@ type PostApiGroupsJSONRequestBody = GroupRequest
// PutApiGroupsGroupIdJSONRequestBody defines body for PutApiGroupsGroupId for application/json ContentType. // PutApiGroupsGroupIdJSONRequestBody defines body for PutApiGroupsGroupId for application/json ContentType.
type PutApiGroupsGroupIdJSONRequestBody = GroupRequest type PutApiGroupsGroupIdJSONRequestBody = GroupRequest
// PostApiIngressPeersJSONRequestBody defines body for PostApiIngressPeers for application/json ContentType.
type PostApiIngressPeersJSONRequestBody = IngressPeerCreateRequest
// PutApiIngressPeersIngressPeerIdJSONRequestBody defines body for PutApiIngressPeersIngressPeerId for application/json ContentType.
type PutApiIngressPeersIngressPeerIdJSONRequestBody = IngressPeerUpdateRequest
// PostApiNetworksJSONRequestBody defines body for PostApiNetworks for application/json ContentType. // PostApiNetworksJSONRequestBody defines body for PostApiNetworks for application/json ContentType.
type PostApiNetworksJSONRequestBody = NetworkRequest type PostApiNetworksJSONRequestBody = NetworkRequest
@ -1631,11 +1637,11 @@ type PutApiNetworksNetworkIdRoutersRouterIdJSONRequestBody = NetworkRouterReques
// PutApiPeersPeerIdJSONRequestBody defines body for PutApiPeersPeerId for application/json ContentType. // PutApiPeersPeerIdJSONRequestBody defines body for PutApiPeersPeerId for application/json ContentType.
type PutApiPeersPeerIdJSONRequestBody = PeerRequest type PutApiPeersPeerIdJSONRequestBody = PeerRequest
// PostApiPeersPeerIdProxyConfigurationsJSONRequestBody defines body for PostApiPeersPeerIdProxyConfigurations for application/json ContentType. // PostApiPeersPeerIdIngressPortsJSONRequestBody defines body for PostApiPeersPeerIdIngressPorts for application/json ContentType.
type PostApiPeersPeerIdProxyConfigurationsJSONRequestBody = ProxyConfigurationRequest type PostApiPeersPeerIdIngressPortsJSONRequestBody = IngressPortAllocationRequest
// PutApiPeersPeerIdProxyConfigurationsConfigurationIdJSONRequestBody defines body for PutApiPeersPeerIdProxyConfigurationsConfigurationId for application/json ContentType. // PutApiPeersPeerIdIngressPortsAllocationIdJSONRequestBody defines body for PutApiPeersPeerIdIngressPortsAllocationId for application/json ContentType.
type PutApiPeersPeerIdProxyConfigurationsConfigurationIdJSONRequestBody = ProxyConfigurationRequest type PutApiPeersPeerIdIngressPortsAllocationIdJSONRequestBody = IngressPortAllocationRequest
// PostApiPoliciesJSONRequestBody defines body for PostApiPolicies for application/json ContentType. // PostApiPoliciesJSONRequestBody defines body for PostApiPolicies for application/json ContentType.
type PostApiPoliciesJSONRequestBody = PolicyUpdate type PostApiPoliciesJSONRequestBody = PolicyUpdate
@ -1649,12 +1655,6 @@ 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
// PostApiProxiesJSONRequestBody defines body for PostApiProxies for application/json ContentType.
type PostApiProxiesJSONRequestBody = ProxyCreateRequest
// PutApiProxiesProxyIdJSONRequestBody defines body for PutApiProxiesProxyId for application/json ContentType.
type PutApiProxiesProxyIdJSONRequestBody = ProxyUpdateRequest
// PostApiRoutesJSONRequestBody defines body for PostApiRoutes for application/json ContentType. // PostApiRoutesJSONRequestBody defines body for PostApiRoutes for application/json ContentType.
type PostApiRoutesJSONRequestBody = RouteRequest type PostApiRoutesJSONRequestBody = RouteRequest