Skip to main content

​
Requirements

  • Go 1.24 or newer
  • Zero external dependencies — the SDK is built on the Go standard library only
  • A valid API key — request one at the Square Cloud Dashboard under My Account → Regenerate API/CLI KEY

​
Installation

go get github.com/squarecloudofc/sdk-api-go/v2
The module ships two packages:
PackageImport pathContents
restgithub.com/squarecloudofc/sdk-api-go/v2/restHTTP client, resource interfaces, request options, errors, SSE stream
squarecloudgithub.com/squarecloudofc/sdk-api-go/v2/squarecloudEvery request/response type and struct

​
Instantiating the client

package main

import (
	"fmt"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v2/rest"
)

func main() {
	client := rest.NewClient(os.Getenv("SQUARECLOUD_API_KEY"))
	defer client.Close()

	api := rest.New(client)

	user, err := api.SelfUser()
	if err != nil {
		panic(err)
	}
	fmt.Println(user.Name)
}
rest.NewClient(token, opts...) builds the underlying HTTP client; rest.New(client) wraps it in rest.Rest, the interface that exposes every resource. Always defer client.Close() to release idle connections.

​
Client configuration (ConfigOpt)

rest.NewClient accepts optional ConfigOpts after the token:
OptionDefaultDescription
rest.WithLogger(*slog.Logger)discardedStructured logger for request/response debugging
rest.WithHTTPClient(*http.Client)30s timeoutCustom *http.Client (proxies, transports, timeouts)
rest.WithURL(string)https://api.squarecloud.app/v2Base API URL
rest.WithUserAgent(string)SDK defaultCustom User-Agent header
client := rest.NewClient(
	os.Getenv("SQUARECLOUD_API_KEY"),
	rest.WithLogger(slog.Default()),
	rest.WithHTTPClient(&http.Client{Timeout: 10 * time.Second}),
)

​
Modules

rest.Rest embeds one interface per resource domain, plus the user and service methods documented on this page:
InterfaceCoverageDocumentation
ApplicationsManage, upload, files, envs, snapshots, deploys, network, realtimeManaging applications
DatabasesCreate, manage, credentials and snapshotsDatabases
WorkspacesCreate, members, shared applicationsWorkspaces

​
Getting the authenticated user

api.SelfUser() returns a squarecloud.User with the account details and current plan. 
user, err := api.SelfUser()
if err != nil {
	panic(err)
}

fmt.Println(user.ID)       // "abcdef0123456789abcdef01"
fmt.Println(user.Name)     // "John Doe"
fmt.Println(user.Email)    // "john@example.com"
fmt.Println(user.Locale)   // "en-US"
fmt.Println(user.Plan.Name)             // e.g. "standard"
fmt.Println(user.Plan.Duration)         // plan duration, e.g. "monthly"
fmt.Println(user.Plan.Memory.Limit)     // MB
fmt.Println(user.Plan.Memory.Available) // MB
fmt.Println(user.Plan.Memory.Used)      // MB
fmt.Println(user.CreatedAt)
FieldTypeDescription
IDstringUser ID (24 hex chars)
NamestringDisplay name
EmailstringAccount email
LocalestringPreferred locale, e.g. "en-US"
Plansquarecloud.UserPlanName, Memory{Limit, Available, Used} (MB) and Duration
CreatedAtstringAccount creation date

​
Listing your applications and databases

api.GetApplications() and api.GetDatabases() list everything you own through the /users/me endpoint, returning compact squarecloud.UserApplication / squarecloud.UserDatabase descriptors: 
apps, err := api.GetApplications()
if err != nil {
	panic(err)
}
for _, app := range apps {
	fmt.Printf("%s (%s) — %dMB\n", app.Name, app.ID, app.RAM)
}

dbs, err := api.GetDatabases()
if err != nil {
	panic(err)
}
for _, db := range dbs {
	fmt.Printf("%s (%s)\n", db.Name, db.ID)
}
To fetch the full record of a single resource, use GetApplication / GetDatabase — see Managing applications and Databases.

​
Listing snapshot history (account-wide)

api.UserSnapshots(scope) returns every snapshot you own for a given domain: 
appSnapshots, err := api.UserSnapshots(squarecloud.SnapshotScopeApplications)
if err != nil {
	panic(err)
}

dbSnapshots, err := api.UserSnapshots(squarecloud.SnapshotScopeDatabases)
if err != nil {
	panic(err)
}
See Snapshots for details on snapshot payloads.

​
Platform status

api.ServiceStatus() exposes the aggregated platform health (the same data shown on the public status page). 
status, err := api.ServiceStatus()
if err != nil {
	panic(err)
}

fmt.Println(status.Status)  // "ok" | "degraded" | "down"
fmt.Println(status.Message) // human-readable summary
Unlike most v2 endpoints, this route does not wrap its payload in the standard { status, code, response } envelope — it responds with { status, message } directly.

​
Request options

Every method accepts trailing ...rest.RequestOpts to customize the individual request:
OptionDescription
rest.WithContext(ctx)Attach a context.Context for cancellation or deadlines
rest.WithQueryParam(key, value)Append a query parameter
rest.WithHeader(key, value)Set a request header
rest.WithToken(token)Override the authentication token for this request only
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

user, err := api.SelfUser(rest.WithContext(ctx))
if err != nil {
	panic(err)
}

​
Error handling

Any non-2xx response is returned as a *rest.APIError exposing StatusCode, Code and Message. Unwrap it with the idiomatic errors.As: 
app, err := api.GetApplication("invalid-id")
if err != nil {
	var apiErr *rest.APIError
	if errors.As(err, &apiErr) {
		fmt.Println(apiErr.StatusCode) // e.g. 404
		fmt.Println(apiErr.Code)       // e.g. "APP_NOT_FOUND"
		fmt.Println(apiErr.Message)
	}
	return
}
Two helpers simplify common checks:
  • rest.ErrorCode(err) string — returns the API error code (or "" when the error is not an *rest.APIError)
  • rest.IsRateLimit(err) bool — reports whether the error is any of the rate-limit codes (KEEP_CALM, RATE_LIMIT, RATE_LIMIT_EXCEEDED, RATELIMIT, DELAY_NOW)
if err != nil {
	if rest.IsRateLimit(err) {
		time.Sleep(5 * time.Second)
		// retry...
	}

	switch rest.ErrorCode(err) {
	case "APP_NOT_FOUND":
		fmt.Println("application does not exist")
	case "ACCESS_DENIED":
		fmt.Println("invalid API key")
	}
}
The error codes are the same ones used by @squarecloud/api-types — see the full code table in the JS SDK reference.