Go SDK

The comprehensive developer platform to build and scale microservices, jobs and managed databases with a powerful UI, API & CLI.

SDK Installation

go get github.com/speakeasy-sdks/northflank-go

SDK Example Usage

Example

package main

import (
	"context"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := northflankgo.New(
		northflankgo.WithSecurity(shared.Security{
			BasicAuth: &shared.SchemeBasicAuth{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Miscellaneous.GetDNSID(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.DNSIDResult != nil {
		// handle response
	}
}

Available Resources and Operations

Miscellaneous

• GetDNSID - Get DNS ID
• HealthCheck - Health check

Addons

• ListAddonTypes - List addon types

Billing

• Get - List invoices
• GetDetails - Get invoice details

CloudProviders

• Create - Create integration
• CreateCluster - Create cluster
• DeleteCluster - Delete cluster
• DeleteIntegration - Delete integration
• Get - List providers
• GetCluster - Get cluster
• GetIntegration - Get integration
• ListClusters - List clusters
• ListIntegrations - List integrations
• UpdateCluster - Update cluster
• UpdateIntegration - Update integration

Domains

• Add - Add subdomain
• Assign - Assign service to subdomain
• Create - Create new domain
• Delete - Delete domain
• DeleteCdn - Remove CDN from a subdomain
• DeleteSubdomain - Delete subdomain
• Enable - Enable CDN on a subdomain
• Get - Get domain
• GetSubdomain - Get subdomain
• ListDomains - List domains
• Unassign - Unassign subdomain
• Verify - Verify subdomain
• VerifyDomain - Verify domain

Integrations

• Add - Add registry
• Create - Create log sink
• Delete - Delete log sink
• DeleteRegistry - Delete registry
• GenerateVCSToken - Generate VCS token
• Get - Get log sink details
• GetBranches - List branches
• GetRegistry - Get registry
• GetRepos - List repositories
• ListLogSinks - List log sinks
• ListRegistries - List registries
• ListVcsProviders - List VCS providers
• Pause - Pause log sink
• Resume - Resume log sink
• Update - Update log sink
• UpdateRegistry - Update registry

Special Types

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. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object	Status Code	Content Type
sdkerrors.APIErrorResult	409	application/json
sdkerrors.SDKError	4xx-5xx	/

Example

package main

import (
	"context"
	"errors"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := northflankgo.New(
		northflankgo.WithSecurity(shared.Security{
			BasicAuth: &shared.SchemeBasicAuth{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	var clusterID string = "gcp-cluster-1"

	ctx := context.Background()
	res, err := s.CloudProviders.DeleteCluster(ctx, clusterID)
	if err != nil {

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

		var e *sdkerrors.SDKError
		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 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
0	https://api.northflank.com	None

Example

package main

import (
	"context"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := northflankgo.New(
		northflankgo.WithServerIndex(0),
		northflankgo.WithSecurity(shared.Security{
			BasicAuth: &shared.SchemeBasicAuth{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Miscellaneous.GetDNSID(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.DNSIDResult != nil {
		// handle response
	}
}

Override Server URL Per-Client

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

package main

import (
	"context"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := northflankgo.New(
		northflankgo.WithServerURL("https://api.northflank.com"),
		northflankgo.WithSecurity(shared.Security{
			BasicAuth: &shared.SchemeBasicAuth{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Miscellaneous.GetDNSID(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.DNSIDResult != 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/myorg/your-go-sdk"
)

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

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

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme
BasicAuth	http	HTTP Basic
BearerAuth	http	HTTP Bearer

You can set the security parameters through the WithSecurity option when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

package main

import (
	"context"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := northflankgo.New(
		northflankgo.WithSecurity(shared.Security{
			BasicAuth: &shared.SchemeBasicAuth{
				Password: "<YOUR_PASSWORD_HERE>",
				Username: "<YOUR_USERNAME_HERE>",
			},
		}),
	)

	ctx := context.Background()
	res, err := s.Miscellaneous.GetDNSID(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.DNSIDResult != nil {
		// handle response
	}
}

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy