Skip to content

Files

Latest commit

 

History

History
269 lines (167 loc) · 10.5 KB

CheckpointApi.md

File metadata and controls

269 lines (167 loc) · 10.5 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.
PrivateCheckpointHealthGetPrivateCheckpointHealthForRegion Get /PrivateCheckpointHealthForRegion Returns the status of the private checkpoints in the given region.
PrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealth Get /PrivateCheckpointHealth Returns the status of the specified private checkpoints.

CheckpointGetAllCheckpoints

CheckpointListResponse CheckpointGetAllCheckpoints(ctx, ) Returns all the checkpoints that are not deleted

Required Parameters

This endpoint does not need any parameter.

Return type

CheckpointListResponse

Authorization

basicauth

HTTP request headers

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

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

CheckpointGetCheckpoint

CheckpointResponse CheckpointGetCheckpoint(ctx, checkpointId) Returns the specified checkpoint, deleted or not

Required Parameters

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

Return type

CheckpointResponse

Authorization

basicauth

HTTP request headers

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

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

CheckpointRegionGetAllCheckpointRegions

[]CheckpointRegion CheckpointRegionGetAllCheckpointRegions(ctx, ) Returns all the checkpoint regions.

Required Parameters

This endpoint does not need any parameter.

Return type

[]CheckpointRegion

Authorization

basicauth

HTTP request headers

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

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

CheckpointRegionGetCheckpointRegionCheckpoints

[]Checkpoint CheckpointRegionGetCheckpointRegionCheckpoints(ctx, checkpointRegionId) Returns the checkpoints for the specified checkpoint region.

Required 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.

Return type

[]Checkpoint

Authorization

basicauth

HTTP request headers

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

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

CheckpointRegionGetSpecifiedCheckpointRegion

CheckpointRegion CheckpointRegionGetSpecifiedCheckpointRegion(ctx, checkpointRegionId) Returns the specified checkpoint region.

Required 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.

Return type

CheckpointRegion

Authorization

basicauth

HTTP request headers

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

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

CheckpointServerGetAllServerIpv4Addresses

ListStringResponse CheckpointServerGetAllServerIpv4Addresses(ctx, ) Anonymous call that returns all the IPv4 addresses of all the checkpoint servers.

Required Parameters

This endpoint does not need any parameter.

Return type

ListStringResponse

Authorization

No authorization required

HTTP request headers

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

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

CheckpointServerGetAllServerIpv6Addresses

ListStringResponse CheckpointServerGetAllServerIpv6Addresses(ctx, ) Anonymous call that returns all the IPv6 addresses of all the checkpoint servers.

Required Parameters

This endpoint does not need any parameter.

Return type

ListStringResponse

Authorization

No authorization required

HTTP request headers

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

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

CheckpointServerGetServer

CheckpoinServerResponse CheckpointServerGetServer(ctx, serverId) Returns the requested checkpoint server.

Required Parameters

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

Return type

CheckpoinServerResponse

Authorization

basicauth

HTTP request headers

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

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

PrivateCheckpointHealthGetPrivateCheckpointHealthForRegion

CheckpointsHealth PrivateCheckpointHealthGetPrivateCheckpointHealthForRegion(ctx, regionId) Returns the status of the private checkpoints in the given region.

Required Parameters

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

Return type

CheckpointsHealth

Authorization

basicauth

HTTP request headers

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

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

PrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealth

CheckpointsHealth PrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealth(ctx, optional) Returns the status of the specified private checkpoints.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CheckpointApiPrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealthOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CheckpointApiPrivateCheckpointHealthGetSpecifiedPrivateCheckpointHealthOpts struct

Name Type Description Notes
filter optional.String [default to ]

Return type

CheckpointsHealth

Authorization

basicauth

HTTP request headers

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

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