Hosterra/scaleway-public-gateway
Hosterra/scaleway-public-gateway
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Initial commit

Browse source
This commit is contained in:
Pierre Lannoy 2025-12-19 14:45:32 +01:00
commit 0bb965d40a
Signed by: Pierre Lannoy
GPG key ID: D27231EF87D53F31
122 changed files with 36116 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/Model/AddBastionAllowedIPsRequest.md Normal file
View file

@ -0,0 +1,9 @@
# # AddBastionAllowedIPsRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip_range** | **string** | IP range allowed to connect to the SSH bastion. (IP network) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

13
docs/Model/CreateGatewayNetworkRequest.md Normal file
View file

@ -0,0 +1,13 @@
# # CreateGatewayNetworkRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gateway_id** | **string** | Public Gateway to connect. (UUID format) | [optional]
**private_network_id** | **string** | Private Network to connect. (UUID format) | [optional]
**enable_masquerade** | **bool** | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. | [optional]
**push_default_route** | **bool** | Enabling the default route also enables masquerading. | [optional]
**ipam_ip_id** | **string** | Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

16
docs/Model/CreateGatewayRequest.md Normal file
View file

@ -0,0 +1,16 @@
# # CreateGatewayRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**project_id** | **string** | Scaleway Project to create the gateway in. (UUID format) | [optional]
**name** | **string** | Name for the gateway. | [optional]
**tags** | **string[]** | Tags for the gateway. | [optional]
**type** | **string** | Gateway type (commercial offer type). | [optional]
**ip_id** | **string** | Existing IP address to attach to the gateway. (UUID format) | [optional]
**enable_smtp** | **bool** | Defines whether SMTP traffic should be allowed pass through the gateway. | [optional]
**enable_bastion** | **bool** | Defines whether SSH bastion should be enabled the gateway. | [optional]
**bastion_port** | **int** | Port of the SSH bastion. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/CreateIPRequest.md Normal file
View file

@ -0,0 +1,10 @@
# # CreateIPRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**project_id** | **string** | Project to create the IP address in. (UUID format) | [optional]
**tags** | **string[]** | Tags to give to the IP address. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

13
docs/Model/CreatePatRuleRequest.md Normal file
View file

@ -0,0 +1,13 @@
# # CreatePatRuleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gateway_id** | **string** | ID of the Gateway on which to create the rule. (UUID format) | [optional]
**public_port** | **int** | Public port to listen on. | [optional]
**private_ip** | **string** | Private IP to forward data to. (IP address) | [optional]
**private_port** | **int** | Private port to translate to. | [optional]
**protocol** | **string** | Protocol the rule should apply to. | [optional] [default to 'unknown_protocol']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/ScalewayVpcGwV2AddBastionAllowedIPsResponse.md Normal file
View file

@ -0,0 +1,9 @@
# # ScalewayVpcGwV2AddBastionAllowedIPsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip_ranges** | **string[]** | Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

28
docs/Model/ScalewayVpcGwV2Gateway.md Normal file
View file

@ -0,0 +1,28 @@
# # ScalewayVpcGwV2Gateway
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | ID of the gateway. (UUID format) | [optional]
**organization_id** | **string** | Owning Organization. (UUID format) | [optional]
**project_id** | **string** | Owning Project. (UUID format) | [optional]
**created_at** | **\DateTime** | Gateway creation date. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | Gateway last modification date. (RFC 3339 format) | [optional]
**type** | **string** | Gateway type name (commercial offer). | [optional]
**bandwidth** | **int** | Bandwidth available of the gateway. | [optional]
**status** | **string** | Current status of the gateway. | [optional] [default to 'unknown_status']
**name** | **string** | Name of the gateway. | [optional]
**tags** | **string[]** | Tags associated with the gateway. | [optional]
**ipv4** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2GatewayIpv4**](ScalewayVpcGwV2GatewayIpv4.md) | | [optional]
**gateway_networks** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2GatewayNetwork[]**](ScalewayVpcGwV2GatewayNetwork.md) | GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network). | [optional]
**version** | **string** | Version of the running gateway software. | [optional]
**can_upgrade_to** | **string** | Newly available gateway software version that can be updated to. | [optional]
**bastion_enabled** | **bool** | Defines whether SSH bastion is enabled on the gateway. | [optional]
**bastion_port** | **int** | Port of the SSH bastion. | [optional]
**smtp_enabled** | **bool** | Defines whether SMTP traffic is allowed to pass through the gateway. | [optional]
**is_legacy** | **bool** | Defines whether the gateway uses non-IPAM IP configurations. | [optional]
**bastion_allowed_ips** | **string[]** | Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network) | [optional]
**zone** | **string** | Zone of the gateway. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

18
docs/Model/ScalewayVpcGwV2GatewayIpv4.md Normal file
View file

@ -0,0 +1,18 @@
# # ScalewayVpcGwV2GatewayIpv4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | IP address ID. (UUID format) | [optional]
**organization_id** | **string** | Owning Organization. (UUID format) | [optional]
**project_id** | **string** | Owning Project. (UUID format) | [optional]
**created_at** | **\DateTime** | IP address creation date. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | IP address last modification date. (RFC 3339 format) | [optional]
**tags** | **string[]** | Tags associated with the IP address. | [optional]
**address** | **string** | The IP address itself. (IP address) | [optional]
**reverse** | **string** | Reverse domain name for the IP address. | [optional]
**gateway_id** | **string** | Public Gateway associated with the IP address. (UUID format) | [optional]
**zone** | **string** | Zone of the IP address. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

19
docs/Model/ScalewayVpcGwV2GatewayNetwork.md Normal file
View file

@ -0,0 +1,19 @@
# # ScalewayVpcGwV2GatewayNetwork
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | ID of the Public Gateway-Private Network connection. (UUID format) | [optional]
**created_at** | **\DateTime** | Connection creation date. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | Connection last modification date. (RFC 3339 format) | [optional]
**gateway_id** | **string** | ID of the connected Public Gateway. (UUID format) | [optional]
**private_network_id** | **string** | ID of the connected Private Network. (UUID format) | [optional]
**mac_address** | **string** | MAC address of the gateway in the Private Network (if the gateway is up and running). | [optional]
**masquerade_enabled** | **bool** | Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT). | [optional]
**status** | **string** | Current status of the Public Gateway's connection to the Private Network. | [optional] [default to 'unknown_status']
**push_default_route** | **bool** | Enabling the default route also enables masquerading. | [optional]
**ipam_ip_id** | **string** | Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format) | [optional]
**zone** | **string** | Zone of the GatewayNetwork connection. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

8
docs/Model/ScalewayVpcGwV2GatewayNetworkStatus.md Normal file
View file

@ -0,0 +1,8 @@
# # ScalewayVpcGwV2GatewayNetworkStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

8
docs/Model/ScalewayVpcGwV2GatewayStatus.md Normal file
View file

@ -0,0 +1,8 @@
# # ScalewayVpcGwV2GatewayStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

11
docs/Model/ScalewayVpcGwV2GatewayType.md Normal file
View file

@ -0,0 +1,11 @@
# # ScalewayVpcGwV2GatewayType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Public Gateway type name. | [optional]
**bandwidth** | **int** | Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to the outer Internet, and the internal bandwidth to each connected Private Networks. | [optional]
**zone** | **string** | Zone the Public Gateway type is available in. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

18
docs/Model/ScalewayVpcGwV2IP.md Normal file
View file

@ -0,0 +1,18 @@
# # ScalewayVpcGwV2IP
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | IP address ID. (UUID format) | [optional]
**organization_id** | **string** | Owning Organization. (UUID format) | [optional]
**project_id** | **string** | Owning Project. (UUID format) | [optional]
**created_at** | **\DateTime** | IP address creation date. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | IP address last modification date. (RFC 3339 format) | [optional]
**tags** | **string[]** | Tags associated with the IP address. | [optional]
**address** | **string** | The IP address itself. (IP address) | [optional]
**reverse** | **string** | Reverse domain name for the IP address. | [optional]
**gateway_id** | **string** | Public Gateway associated with the IP address. (UUID format) | [optional]
**zone** | **string** | Zone of the IP address. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayVpcGwV2ListGatewayNetworksResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayVpcGwV2ListGatewayNetworksResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gateway_networks** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2GatewayNetwork[]**](ScalewayVpcGwV2GatewayNetwork.md) | GatewayNetworks on this page. | [optional]
**total_count** | **int** | Total GatewayNetworks count matching the filter. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/ScalewayVpcGwV2ListGatewayTypesResponse.md Normal file
View file

@ -0,0 +1,9 @@
# # ScalewayVpcGwV2ListGatewayTypesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**types** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2GatewayType[]**](ScalewayVpcGwV2GatewayType.md) | Available types of Public Gateway. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayVpcGwV2ListGatewaysResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayVpcGwV2ListGatewaysResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gateways** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2Gateway[]**](ScalewayVpcGwV2Gateway.md) | Gateways on this page. | [optional]
**total_count** | **int** | Total count of gateways matching the filter. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayVpcGwV2ListIPsResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayVpcGwV2ListIPsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ips** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2IP[]**](ScalewayVpcGwV2IP.md) | IP addresses on this page. | [optional]
**total_count** | **int** | Total count of IP addresses matching the filter. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayVpcGwV2ListPatRulesResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayVpcGwV2ListPatRulesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pat_rules** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2PatRule[]**](ScalewayVpcGwV2PatRule.md) | Array of PAT rules matching the filter. | [optional]
**total_count** | **int** | Total count of PAT rules matching the filter. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

17
docs/Model/ScalewayVpcGwV2PatRule.md Normal file
View file

@ -0,0 +1,17 @@
# # ScalewayVpcGwV2PatRule
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | PAT rule ID. (UUID format) | [optional]
**gateway_id** | **string** | Gateway the PAT rule applies to. (UUID format) | [optional]
**created_at** | **\DateTime** | PAT rule creation date. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | PAT rule last modification date. (RFC 3339 format) | [optional]
**public_port** | **int** | Public port to listen on. | [optional]
**private_ip** | **string** | Private IP address to forward data to. (IP address) | [optional]
**private_port** | **int** | Private port to translate to. | [optional]
**protocol** | **string** | Protocol the rule applies to. | [optional] [default to 'unknown_protocol']
**zone** | **string** | Zone of the PAT rule. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/ScalewayVpcGwV2SetBastionAllowedIPsResponse.md Normal file
View file

@ -0,0 +1,9 @@
# # ScalewayVpcGwV2SetBastionAllowedIPsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip_ranges** | **string[]** | Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

12
docs/Model/ScalewayVpcGwV2SetPatRulesRequestRule.md Normal file
View file

@ -0,0 +1,12 @@
# # ScalewayVpcGwV2SetPatRulesRequestRule
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**public_port** | **int** | Public port to listen on. Public port to listen on. Uniquely identifies the rule, and a matching rule will be updated with the new parameters. | [optional]
**private_ip** | **string** | Private IP to forward data to. (IP address) | [optional]
**private_port** | **int** | Private port to translate to. | [optional]
**protocol** | **string** | Protocol the rule should apply to. | [optional] [default to 'unknown_protocol']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/ScalewayVpcGwV2SetPatRulesResponse.md Normal file
View file

@ -0,0 +1,9 @@
# # ScalewayVpcGwV2SetPatRulesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pat_rules** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2PatRule[]**](ScalewayVpcGwV2PatRule.md) | List of PAT rules. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/SetBastionAllowedIPsRequest.md Normal file
View file

@ -0,0 +1,9 @@
# # SetBastionAllowedIPsRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip_ranges** | **string[]** | New list of IP ranges (each range in CIDR notation) allowed to connect to the SSH bastion. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/SetPatRulesRequest.md Normal file
View file

@ -0,0 +1,10 @@
# # SetPatRulesRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**gateway_id** | **string** | ID of the gateway on which to set the PAT rules. (UUID format) | [optional]
**pat_rules** | [**\OpenAPI\Client\Model\ScalewayVpcGwV2SetPatRulesRequestRule[]**](ScalewayVpcGwV2SetPatRulesRequestRule.md) | New list of PAT rules. |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

11
docs/Model/UpdateGatewayNetworkRequest.md Normal file
View file

@ -0,0 +1,11 @@
# # UpdateGatewayNetworkRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enable_masquerade** | **bool** | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. | [optional]
**push_default_route** | **bool** | Enabling the default route also enables masquerading. | [optional]
**ipam_ip_id** | **string** | Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

13
docs/Model/UpdateGatewayRequest.md Normal file
View file

@ -0,0 +1,13 @@
# # UpdateGatewayRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name for the gateway. | [optional]
**tags** | **string[]** | Tags for the gateway. | [optional]
**enable_bastion** | **bool** | Defines whether SSH bastion should be enabled the gateway. | [optional]
**bastion_port** | **int** | Port of the SSH bastion. | [optional]
**enable_smtp** | **bool** | Defines whether SMTP traffic should be allowed to pass through the gateway. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

11
docs/Model/UpdateIPRequest.md Normal file
View file

@ -0,0 +1,11 @@
# # UpdateIPRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tags** | **string[]** | Tags to give to the IP address. | [optional]
**reverse** | **string** | Reverse to set on the address. Empty string to unset. | [optional]
**gateway_id** | **string** | Gateway to attach the IP address to. Empty string to detach. (UUID format) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

12
docs/Model/UpdatePatRuleRequest.md Normal file
View file

@ -0,0 +1,12 @@
# # UpdatePatRuleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**public_port** | **int** | Public port to listen on. | [optional]
**private_ip** | **string** | Private IP to forward data to. (IP address) | [optional]
**private_port** | **int** | Private port to translate to. | [optional]
**protocol** | **string** | Protocol the rule should apply to. | [optional] [default to 'unknown_protocol']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/UpgradeGatewayRequest.md Normal file
View file

@ -0,0 +1,9 @@
# # UpgradeGatewayRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | Gateway type (commercial offer). | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)