Skip to content

Latest commit

 

History

History
290 lines (184 loc) · 8.65 KB

File metadata and controls

290 lines (184 loc) · 8.65 KB

\StandardRegionsAPI

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

Method HTTP request Description
StandardGetRegion Get /v3/networks/standard/{networkId}/regions/{regionId} Get region by ID
StandardNetworksControllerV2AddNetworkRegion Put /v3/networks/standard/{networkId}/regions Add regions to a network
StandardNetworksControllerV2DeleteNetworkRegion Delete /v3/networks/standard/{networkId}/regions Remove regions from network
StandardNetworksControllerV2GetRegions Get /v3/networks/standard/harmony-sase-regions List of available Harmony SASE regions that support standard networks

StandardGetRegion

NetworkRegion StandardGetRegion(ctx, networkId, regionId).Execute()

Get region by ID

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.StandardRegionsAPI.StandardGetRegion(context.Background(), networkId, regionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StandardRegionsAPI.StandardGetRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StandardGetRegion`: NetworkRegion
	fmt.Fprintf(os.Stdout, "Response from `StandardRegionsAPI.StandardGetRegion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
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 apiStandardGetRegionRequest struct via the builder pattern

Name Type Description Notes

Return type

NetworkRegion

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]

StandardNetworksControllerV2AddNetworkRegion

AsyncOperationResult StandardNetworksControllerV2AddNetworkRegion(ctx, networkId).CreateRegionInNetworkPayload(createRegionInNetworkPayload).Execute()

Add regions to a network

Example

package main

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

func main() {
	networkId := "networkId_example" // string | 
	createRegionInNetworkPayload := *openapiclient.NewCreateRegionInNetworkPayload("HarmonySaseRegionId_example", false) // CreateRegionInNetworkPayload | 

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

Name Type Description Notes

createRegionInNetworkPayload | CreateRegionInNetworkPayload | |

Return type

AsyncOperationResult

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]

StandardNetworksControllerV2DeleteNetworkRegion

AsyncOperationResult StandardNetworksControllerV2DeleteNetworkRegion(ctx, networkId).RemoveRegionDTO(removeRegionDTO).Execute()

Remove regions from network

Example

package main

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

func main() {
	networkId := "networkId_example" // string | 
	removeRegionDTO := *openapiclient.NewRemoveRegionDTO("RegionId_example") // RemoveRegionDTO | 

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

Name Type Description Notes

removeRegionDTO | RemoveRegionDTO | |

Return type

AsyncOperationResult

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]

StandardNetworksControllerV2GetRegions

[]Region StandardNetworksControllerV2GetRegions(ctx).Execute()

List of available Harmony SASE regions that support standard 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.StandardRegionsAPI.StandardNetworksControllerV2GetRegions(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StandardRegionsAPI.StandardNetworksControllerV2GetRegions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StandardNetworksControllerV2GetRegions`: []Region
	fmt.Fprintf(os.Stdout, "Response from `StandardRegionsAPI.StandardNetworksControllerV2GetRegions`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]Region

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]