Skip to content

CheckpointAPI.md

Latest commit

 

History

History
524 lines (340 loc) · 15.4 KB

CheckpointAPI.md

File metadata and controls

524 lines (340 loc) · 15.4 KB

\CheckpointAPI

All URIs are relative to https://api.uptrends.com/v4

Method HTTP request Description
CheckpointGetAllCheckpoints Get /Checkpoint Returns all the checkpoints that are not deleted
CheckpointGetCheckpoint Get /Checkpoint/{checkpointId} Returns the specified checkpoint, deleted or not
CheckpointRegionGetAllCheckpointRegions Get /CheckpointRegion Returns all the checkpoint regions.
CheckpointRegionGetCheckpointRegionCheckpoints Get /CheckpointRegion/{checkpointRegionId}/Checkpoint Returns the checkpoints for the specified checkpoint region.
CheckpointRegionGetSpecifiedCheckpointRegion Get /CheckpointRegion/{checkpointRegionId} Returns the specified checkpoint region.
CheckpointServerGetAllServerIpv4Addresses Get /Checkpoint/Server/Ipv4 Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.
CheckpointServerGetAllServerIpv6Addresses Get /Checkpoint/Server/Ipv6 Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.
CheckpointServerGetServer Get /Checkpoint/Server/{serverId} Returns the requested checkpoint server.

CheckpointGetAllCheckpoints

CheckpointListResponse CheckpointGetAllCheckpoints(ctx).Execute()

Returns all the checkpoints that are not deleted

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

CheckpointListResponse

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointGetCheckpoint

CheckpointResponse CheckpointGetCheckpoint(ctx, checkpointId).Execute()

Returns the specified checkpoint, deleted or not

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	checkpointId := int32(56) // int32 | The Id of the requested checkpoint.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
checkpointId int32 The Id of the requested checkpoint.

Other Parameters

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

Name Type Description Notes

Return type

CheckpointResponse

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointRegionGetAllCheckpointRegions

[]CheckpointRegion CheckpointRegionGetAllCheckpointRegions(ctx).Execute()

Returns all the checkpoint regions.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]CheckpointRegion

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointRegionGetCheckpointRegionCheckpoints

[]Checkpoint CheckpointRegionGetCheckpointRegionCheckpoints(ctx, checkpointRegionId).Execute()

Returns the checkpoints for the specified checkpoint region.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	checkpointRegionId := int32(56) // int32 | The id for the specified checkpoint region.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
checkpointRegionId int32 The id for the specified checkpoint region.

Other Parameters

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

Name Type Description Notes

Return type

[]Checkpoint

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointRegionGetSpecifiedCheckpointRegion

CheckpointRegion CheckpointRegionGetSpecifiedCheckpointRegion(ctx, checkpointRegionId).Execute()

Returns the specified checkpoint region.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	checkpointRegionId := int32(56) // int32 | The id for the specified checkpoint region.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
checkpointRegionId int32 The id for the specified checkpoint region.

Other Parameters

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

Name Type Description Notes

Return type

CheckpointRegion

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointServerGetAllServerIpv4Addresses

ListStringResponse CheckpointServerGetAllServerIpv4Addresses(ctx).Execute()

Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListStringResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointServerGetAllServerIpv6Addresses

ListStringResponse CheckpointServerGetAllServerIpv6Addresses(ctx).Execute()

Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListStringResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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

CheckpointServerGetServer

CheckpoinServerResponse CheckpointServerGetServer(ctx, serverId).Execute()

Returns the requested checkpoint server.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	serverId := int32(56) // int32 | The Id of the requested server.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serverId int32 The Id of the requested server.

Other Parameters

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

Name Type Description Notes

Return type

CheckpoinServerResponse

Authorization

basicauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

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