\EnhancedRegionsAPI

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

Method	HTTP request	Description
CreateEnhancedRegion	Post /v3/networks/enhanced/{networkId}/regions	Create enhanced region
DeleteEnhancedRegion	Delete /v3/networks/enhanced/{networkId}/regions/{regionId}	Delete enhanced region
EnhancedNetworksControllerV2GetRegions	Get /v3/networks/enhanced/harmony-sase-regions	List of available Harmony SASE regions that supports enhanced networks
GetEnhancedRegion	Get /v3/networks/enhanced/{networkId}/regions/{regionId}	Get region
IncreaseScaleUnit	Put /v3/networks/enhanced/{networkId}/regions/{regionId}/scale-unit/increase	Increase scale units
ListEnhancedRegions	Get /v3/networks/enhanced/{networkId}/regions	List regions
ReduceScaleUnit	Put /v3/networks/enhanced/{networkId}/regions/{regionId}/scale-unit/reduce	Reduce scale units

CreateEnhancedRegion

AsyncOperationResponse CreateEnhancedRegion(ctx, networkId).EnhancedRegionCreate(enhancedRegionCreate).Execute()

Create enhanced region

Example

package main

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

func main() {
	networkId := "networkId_example" // string | 
	enhancedRegionCreate := *openapiclient.NewEnhancedRegionCreate("HarmonySaseRegionId_example") // EnhancedRegionCreate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.CreateEnhancedRegion(context.Background(), networkId).EnhancedRegionCreate(enhancedRegionCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.CreateEnhancedRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateEnhancedRegion`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.CreateEnhancedRegion`: %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 apiCreateEnhancedRegionRequest struct via the builder pattern

Name	Type	Description	Notes

enhancedRegionCreate | EnhancedRegionCreate | |

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]

DeleteEnhancedRegion

AsyncOperationResponse DeleteEnhancedRegion(ctx, networkId, regionId).Execute()

Delete enhanced 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 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.DeleteEnhancedRegion(context.Background(), networkId, regionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.DeleteEnhancedRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteEnhancedRegion`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.DeleteEnhancedRegion`: %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 apiDeleteEnhancedRegionRequest 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]

EnhancedNetworksControllerV2GetRegions

[]HarmonySaseRegion EnhancedNetworksControllerV2GetRegions(ctx).Execute()

List of available Harmony SASE regions that supports enhanced networks

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]HarmonySaseRegion

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]

GetEnhancedRegion

EnhancedRegion GetEnhancedRegion(ctx, networkId, regionId).Execute()

Get 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 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.GetEnhancedRegion(context.Background(), networkId, regionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.GetEnhancedRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEnhancedRegion`: EnhancedRegion
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.GetEnhancedRegion`: %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 apiGetEnhancedRegionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EnhancedRegion

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]

IncreaseScaleUnit

AsyncOperationResponse IncreaseScaleUnit(ctx, networkId, regionId).ScaleUnitsOperation(scaleUnitsOperation).Execute()

Increase scale units

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 | 
	scaleUnitsOperation := *openapiclient.NewScaleUnitsOperation("UnitType_example", int32(123)) // ScaleUnitsOperation | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.IncreaseScaleUnit(context.Background(), networkId, regionId).ScaleUnitsOperation(scaleUnitsOperation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.IncreaseScaleUnit``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `IncreaseScaleUnit`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.IncreaseScaleUnit`: %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 apiIncreaseScaleUnitRequest struct via the builder pattern

Name	Type	Description	Notes

scaleUnitsOperation | ScaleUnitsOperation | |

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]

ListEnhancedRegions

[]EnhancedRegion ListEnhancedRegions(ctx, networkId).Execute()

List regions

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.ListEnhancedRegions(context.Background(), networkId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.ListEnhancedRegions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListEnhancedRegions`: []EnhancedRegion
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.ListEnhancedRegions`: %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 apiListEnhancedRegionsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]EnhancedRegion

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]

ReduceScaleUnit

AsyncOperationResponse ReduceScaleUnit(ctx, networkId, regionId).ScaleUnitsOperation(scaleUnitsOperation).Execute()

Reduce scale units

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 | 
	scaleUnitsOperation := *openapiclient.NewScaleUnitsOperation("UnitType_example", int32(123)) // ScaleUnitsOperation | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnhancedRegionsAPI.ReduceScaleUnit(context.Background(), networkId, regionId).ScaleUnitsOperation(scaleUnitsOperation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnhancedRegionsAPI.ReduceScaleUnit``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ReduceScaleUnit`: AsyncOperationResponse
	fmt.Fprintf(os.Stdout, "Response from `EnhancedRegionsAPI.ReduceScaleUnit`: %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 apiReduceScaleUnitRequest struct via the builder pattern

Name	Type	Description	Notes

scaleUnitsOperation | ScaleUnitsOperation | |

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

EnhancedRegionsAPI.md

Latest commit

History

EnhancedRegionsAPI.md

File metadata and controls

\EnhancedRegionsAPI

CreateEnhancedRegion

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteEnhancedRegion

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EnhancedNetworksControllerV2GetRegions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetEnhancedRegion

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

IncreaseScaleUnit

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListEnhancedRegions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReduceScaleUnit

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers