\EnhancedTunnelsAPI

All URIs are relative to https://virtserver.swaggerhub.com/perimeter81/public-api-yaml/1.0.0

Method	HTTP request	Description
CreateDynamicTunnel	Post /v3/networks/enhanced/{networkId}/tunnels/ipsec/dynamic	Create dynamic IPSec tunnel
CreateStaticTunnel	Post /v3/networks/enhanced/{networkId}/tunnels/ipsec/static	Create static IPSec tunnel
DeleteDynamicTunnel	Delete /v3/networks/enhanced/{networkId}/tunnels/ipsec/dynamic/{dynamicTunnelId}	Delete dynamic IPSec tunnel
DeleteStaticTunnel	Delete /v3/networks/enhanced/{networkId}/tunnels/ipsec/static/{tunnelId}	Delete static IPSec tunnel
GetDynamicTunnel	Get /v3/networks/enhanced/{networkId}/tunnels/ipsec/dynamic/{dynamicTunnelId}	Get dynamic IPSec tunnel
GetEnhancedRegionTunnelsPerNetwork	Get /v3/networks/enhanced/{networkId}/tunnels	Get tunnels for a network
GetEnhancedRegionTunnelsPerRegion	Get /v3/networks/enhanced/{networkId}/regions/{regionId}/tunnels	Get tunnels for a region
GetStaticTunnel	Get /v3/networks/enhanced/{networkId}/tunnels/ipsec/static/{tunnelId}	Get static IPSec tunnel
UpdateDynamicTunnel	Put /v3/networks/enhanced/{networkId}/tunnels/ipsec/dynamic/{dynamicTunnelId}	Update dynamic IPSec tunnel
UpdateStaticTunnel	Put /v3/networks/enhanced/{networkId}/tunnels/ipsec/static/{tunnelId}	Update static IPSec tunnel

CreateDynamicTunnel

AsyncOperationResponse CreateDynamicTunnel(ctx, networkId).DynamicTunnelCreate(dynamicTunnelCreate).Execute()

Create dynamic IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	dynamicTunnelCreate := *openapiclient.NewDynamicTunnelCreate("TunnelName_example", []openapiclient.DynamicTunnelDetails{*openapiclient.NewDynamicTunnelDetails("AuthType_example", "RegionID_example", "P81GWInternalIP_example", "RemoteGWInternalIP_example", "RemotePublicIP_example", int32(123), "RemoteID_example", openapiclient.RoutingType("route"))}, *openapiclient.NewEnhancedIPSecSharedSettingsCreate([]string{"P81GatewaySubnets_example"}, []string{"RemoteGatewaySubnets_example"}, *openapiclient.NewNetworkFeaturesCreate(*openapiclient.NewNetworkFeaturesCloudSecurity(false), *openapiclient.NewNetworkFeaturesCloudSecurity(false), *openapiclient.NewNetworkFeaturesDNSServices(*openapiclient.NewNetworkFeaturesDNSServicesRedirectToResolver(false))), int32(123)), *openapiclient.NewIPSecAdvancedSettingsV23("KeyExchange_example", "IkeLifeTime_example", "Lifetime_example", "DpdDelay_example", "DpdTimeout_example", *openapiclient.NewIPSecPhaseConfigV23([]string{"Auth_example"}, []string{"Encryption_example"}, []string{"KeyExchangeMethod_example"}), *openapiclient.NewIPSecPhaseConfigV23([]string{"Auth_example"}, []string{"Encryption_example"}, []string{"KeyExchangeMethod_example"}))) // DynamicTunnelCreate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.CreateDynamicTunnel(context.Background(), networkId).DynamicTunnelCreate(dynamicTunnelCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.CreateDynamicTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDynamicTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.CreateDynamicTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateDynamicTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

dynamicTunnelCreate | DynamicTunnelCreate | |

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateStaticTunnel

AsyncOperationResponse CreateStaticTunnel(ctx, networkId).StaticTunnelCreate(staticTunnelCreate).Execute()

Create static IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	staticTunnelCreate := *openapiclient.NewStaticTunnelCreate("AuthType_example", "RegionID_example", "TunnelName_example", []string{"P81GatewaySubnets_example"}, []string{"RemoteGatewaySubnets_example"}, "KeyExchange_example", "IkeLifeTime_example", "Lifetime_example", "DpdDelay_example", "DpdTimeout_example", *openapiclient.NewIPSecPhaseConfigV23([]string{"Auth_example"}, []string{"Encryption_example"}, []string{"KeyExchangeMethod_example"}), *openapiclient.NewIPSecPhaseConfigV23([]string{"Auth_example"}, []string{"Encryption_example"}, []string{"KeyExchangeMethod_example"}), "RemotePublicIP_example", "RemoteID_example", *openapiclient.NewNetworkFeaturesCreate(*openapiclient.NewNetworkFeaturesCloudSecurity(false), *openapiclient.NewNetworkFeaturesCloudSecurity(false), *openapiclient.NewNetworkFeaturesDNSServices(*openapiclient.NewNetworkFeaturesDNSServicesRedirectToResolver(false))), openapiclient.RoutingType("route")) // StaticTunnelCreate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.CreateStaticTunnel(context.Background(), networkId).StaticTunnelCreate(staticTunnelCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.CreateStaticTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateStaticTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.CreateStaticTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateStaticTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

staticTunnelCreate | StaticTunnelCreate | |

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteDynamicTunnel

AsyncOperationResponse DeleteDynamicTunnel(ctx, networkId, dynamicTunnelId).Execute()

Delete dynamic IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	dynamicTunnelId := "dynamicTunnelId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.DeleteDynamicTunnel(context.Background(), networkId, dynamicTunnelId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.DeleteDynamicTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteDynamicTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.DeleteDynamicTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
dynamicTunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteDynamicTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteStaticTunnel

AsyncOperationResponse DeleteStaticTunnel(ctx, networkId, tunnelId).Execute()

Delete static IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	tunnelId := "tunnelId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.DeleteStaticTunnel(context.Background(), networkId, tunnelId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.DeleteStaticTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteStaticTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.DeleteStaticTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
tunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteStaticTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDynamicTunnel

[]EnhancedTunnel GetDynamicTunnel(ctx, networkId, dynamicTunnelId).Execute()

Get dynamic IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	dynamicTunnelId := "dynamicTunnelId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.GetDynamicTunnel(context.Background(), networkId, dynamicTunnelId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.GetDynamicTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDynamicTunnel`: []EnhancedTunnel
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.GetDynamicTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
dynamicTunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetDynamicTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]EnhancedTunnel

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnhancedRegionTunnelsPerNetwork

GetEnhancedRegionTunnelsPerNetwork200Response GetEnhancedRegionTunnelsPerNetwork(ctx, networkId).Page(page).Limit(limit).Execute()

Get tunnels for a network

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	page := int32(56) // int32 | Specifies the current page of the paginated result set (optional)
	limit := int32(56) // int32 | Defines the number of results per page (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerNetwork(context.Background(), networkId).Page(page).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerNetwork``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEnhancedRegionTunnelsPerNetwork`: GetEnhancedRegionTunnelsPerNetwork200Response
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetEnhancedRegionTunnelsPerNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetEnhancedRegionTunnelsPerNetwork200Response

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnhancedRegionTunnelsPerRegion

GetEnhancedRegionTunnelsPerNetwork200Response GetEnhancedRegionTunnelsPerRegion(ctx, networkId, regionId).Page(page).Limit(limit).Execute()

Get tunnels for a region

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	regionId := "regionId_example" // string | 
	page := int32(56) // int32 | Specifies the current page of the paginated result set (optional)
	limit := int32(56) // int32 | Defines the number of results per page (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerRegion(context.Background(), networkId, regionId).Page(page).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEnhancedRegionTunnelsPerRegion`: GetEnhancedRegionTunnelsPerNetwork200Response
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.GetEnhancedRegionTunnelsPerRegion`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
regionId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetEnhancedRegionTunnelsPerRegionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetEnhancedRegionTunnelsPerNetwork200Response

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStaticTunnel

EnhancedTunnel GetStaticTunnel(ctx, networkId, tunnelId).Execute()

Get static IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	tunnelId := "tunnelId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.GetStaticTunnel(context.Background(), networkId, tunnelId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.GetStaticTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetStaticTunnel`: EnhancedTunnel
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.GetStaticTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
tunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetStaticTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EnhancedTunnel

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDynamicTunnel

AsyncOperationResponse UpdateDynamicTunnel(ctx, networkId, dynamicTunnelId).DynamicTunnelUpdate(dynamicTunnelUpdate).Execute()

Update dynamic IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	dynamicTunnelId := "dynamicTunnelId_example" // string | 
	dynamicTunnelUpdate := *openapiclient.NewDynamicTunnelUpdate("TunnelName_example") // DynamicTunnelUpdate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.UpdateDynamicTunnel(context.Background(), networkId, dynamicTunnelId).DynamicTunnelUpdate(dynamicTunnelUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.UpdateDynamicTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDynamicTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.UpdateDynamicTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
dynamicTunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateDynamicTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

dynamicTunnelUpdate | DynamicTunnelUpdate | |

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateStaticTunnel

AsyncOperationResponse UpdateStaticTunnel(ctx, networkId, tunnelId).StaticTunnelUpdate(staticTunnelUpdate).Execute()

Update static IPSec tunnel

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CheckPointSW/perimeter-81-client-sdk/v3"
)

func main() {
	networkId := "networkId_example" // string | 
	tunnelId := "tunnelId_example" // string | 
	staticTunnelUpdate := *openapiclient.NewStaticTunnelUpdate() // StaticTunnelUpdate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedTunnelsAPI.UpdateStaticTunnel(context.Background(), networkId, tunnelId).StaticTunnelUpdate(staticTunnelUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedTunnelsAPI.UpdateStaticTunnel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateStaticTunnel`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedTunnelsAPI.UpdateStaticTunnel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId	string
tunnelId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateStaticTunnelRequest struct via the builder pattern

Name	Type	Description	Notes

staticTunnelUpdate | StaticTunnelUpdate | |

Return type

AsyncOperationResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

EnhancedTunnelsAPI.md

Latest commit

History

EnhancedTunnelsAPI.md

File metadata and controls

\EnhancedTunnelsAPI

CreateDynamicTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateStaticTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteDynamicTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteStaticTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDynamicTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetEnhancedRegionTunnelsPerNetwork

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetEnhancedRegionTunnelsPerRegion

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetStaticTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateDynamicTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateStaticTunnel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers