latitudesh-go-sdk

Summary

Latitude.sh API: The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It allows you to perform the same actions as the Latitude.sh dashboard.

Table of Contents

• latitudesh-go-sdk
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Pagination
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/latitudesh/latitudesh-go-sdk

SDK Example Usage

Example

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
Bearer	apiKey	API key	LATITUDESH_BEARER

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

ApiKeys

• List - List API keys
• Create - Create API key
• Update - Rotate API key
• Delete - Delete API key
• UpdateAPIKey - Update API key settings

Billing

• ListUsage - Retrieve billing usage

ElasticIps

• ListElasticIps - List Elastic IPs
• CreateElasticIP - Create an Elastic IP
• GetElasticIP - Retrieve an Elastic IP
• DeleteElasticIP - Release an Elastic IP
• UpdateElasticIP - Move an Elastic IP

Events

• List - List events

Firewalls

• GetAllFirewallAssignments - List firewall assignments
• Create - Create firewall
• List - List firewalls
• Get - Retrieve firewall
• Update - Update firewall
• Delete - Delete firewall
• ListAssignments - Firewall assignments
• DeleteAssignment - Delete assignment

Firewalls.Assignments

• Create - Assign server to firewall

IpAddresses

• List - List IPs
• Get - Retrieve an IP

KubernetesClusters

• ListKubernetesClusters - List Kubernetes Clusters
• CreateKubernetesCluster - Create a Kubernetes Cluster
• GetKubernetesCluster - Get a Kubernetes Cluster
• DeleteKubernetesCluster - Delete a Kubernetes Cluster
• UpdateKubernetesCluster - Scale Kubernetes Cluster Workers
• GetKubernetesClusterKubeconfig - Get Kubernetes Cluster Kubeconfig

OperatingSystems

• ListPlans - List operating systems

Plans

• List - List plans
• Get - Retrieve plan
• GetBandwidth - List bandwidth plans
• UpdateBandwidth - Update bandwidth packages
• ListStorage - List storage plans

Plans.Vm

• List - List VM plans

PrivateNetworks

• List - List VLANs
• Create - Create VLAN
• Update - Update VLAN
• Get - Retrieve VLAN
• ListAssignments - List VLAN assignments
• Assign - Assign VLAN
• DeleteAssignment - Delete VLAN assignment

Projects

• List - List projects
• Create - Create project
• Update - Update project
• Delete - Delete project

Projects.SshKeys

• PostProjectSSHKey - Create SSH Key ⚠️ Deprecated

Regions

• Get - List regions
• Fetch - Retrieve region

Roles

• List - List roles
• Get - Retrieve role

Servers

• List - List servers
• Create - Create server
• Get - Retrieve server
• Update - Update server
• Delete - Remove server
• GetDeployConfig - Retrieve deploy config
• UpdateDeployConfig - Update deploy config
• Lock - Lock server
• Unlock - Unlock server
• StartOutOfBandConnection - Create out-of-band connection
• GetOutOfBand - List out-of-band connections
• RunAction - Run power action
• CreateIpmiSession - Create IPMI credentials
• StartRescueMode - Put server in rescue mode
• ExitRescueMode - Exits rescue mode
• ScheduleDeletion - Schedule server deletion
• UnscheduleDeletion - Unschedule server deletion
• Reinstall - Run Server Reinstall

SSHKeys

• List - List SSH Keys ⚠️ Deprecated
• Get - Retrieve Project SSH Key ⚠️ Deprecated
• ModifyProjectKey - Update Project SSH Key ⚠️ Deprecated
• RemoveFromProject - Delete Project SSH Key ⚠️ Deprecated
• ListAll - List SSH Keys
• Create - Create SSH Key
• Retrieve - Retrieve SSH Key
• Update - Update SSH Key
• Delete - Delete SSH Key

Storage

• CreateFilesystem - Create filesystem
• ListFilesystems - List filesystems
• DeleteFilesystem - Delete filesystem
• UpdateFilesystem - Update filesystem
• GetStorageVolumes - List volumes
• PostStorageVolumes - Create volume
• GetStorageVolume - Retrieve volume
• DeleteStorageVolumes - Delete volume
• PostStorageVolumesMount - Mount volume
• GetStorageObjects - List object storages
• PostStorageObjects - Create object storage
• GetStorageObject - Retrieve object storage
• DeleteStorageObjects - Delete object storage

Tags

• List - List tags
• Create - Create tag
• Update - Update tag
• Delete - Delete tag

TeamMembers

• PostTeamMembers - Create member
• Delete - Remove a member

Teams

• Get - Retrieve team
• Create - Create team
• Update - Update team

Teams.Members

• GetTeamMembers - List members

Traffic

• Get - Retrieve traffic
• GetQuota - Retrieve traffic quota

UserData

• GetProjectUsersData - List Project user data ⚠️ Deprecated
• GetProjectUserData - Retrieve Project user data ⚠️ Deprecated
• DeleteProjectUserData - Delete Project user data ⚠️ Deprecated
• Create - Create Project user data ⚠️ Deprecated
• UpdateForProject - Update Project user data ⚠️ Deprecated
• List - List user data
• CreateNew - Create user data
• Retrieve - Retrieve user data
• Update - Update user data
• Delete - Delete user data

UserProfile

• Get - Retrieve profile
• Update - Update profile
• ListTeams - List user teams

VirtualMachines

• Create - Create VM
• List - List VMs
• Get - Retrieve VM
• Delete - Destroy VM
• UpdateVirtualMachine - Update VM
• CreateVirtualMachineAction - Run VM power action

VirtualNetworks

• Delete - Delete VLAN

VpnSessions

• List - List VPN sessions
• Create - Create VPN session
• RefreshPassword - Refresh VPN session
• Delete - Delete VPN session

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"github.com/latitudesh/latitudesh-go-sdk/models/operations"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.Events.List(ctx, operations.GetEventsRequest{})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"github.com/latitudesh/latitudesh-go-sdk/retry"
	"log"
	"models/operations"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"github.com/latitudesh/latitudesh-go-sdk/retry"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return components.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the CreateElasticIP function may return the following errors:

Error Type	Status Code	Content Type
components.ErrorObject	403, 422	application/vnd.api+json
components.APIError	4XX, 5XX	*/*

Example

package main

import (
	"context"
	"errors"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"github.com/latitudesh/latitudesh-go-sdk/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.ElasticIps.CreateElasticIP(ctx, components.CreateElasticIP{
		Data: components.CreateElasticIPData{
			Type: components.CreateElasticIPTypeElasticIps,
			Attributes: components.CreateElasticIPAttributes{
				ProjectID: "proj_AoW6vRnwkvLn0",
				ServerID:  "sv_2GmAlJ6BXlK1a",
			},
		},
	})
	if err != nil {

		var e *components.ErrorObject
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *components.APIError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex(serverIndex int) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables	Description
0	https://api.latitude.sh	latitude_api_key
1	http://api.latitude.sh	latitude_api_key

If the selected server has variables, you may override its default values using the associated option(s):

Variable	Option	Default	Description
latitude_api_key	WithLatitudeAPIKey(latitudeAPIKey string)	"<insert your api key here>"

Example

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithServerIndex(0),
		latitudeshgosdk.WithLatitudeAPIKey("<insert your api key here>"),
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := latitudeshgosdk.New(
		latitudeshgosdk.WithServerURL("http://api.latitude.sh"),
		latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
	)

	res, err := s.APIKeys.List(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.APIKeys != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"

	"github.com/latitudesh/latitudesh-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = latitudeshgosdk.New(latitudeshgosdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.