Versions in this module Expand all Collapse all v2 v2.0.0 Jul 13, 2026 Changes in this version + var APIURL = fmt.Sprintf("https://api.squarecloud.app/v%d", APIVersion) + var APIVersion = 2 + var EndpointApplication = func() string + var EndpointApplicationAnalytics = func(appID string) string + var EndpointApplicationCommit = func(appID string) string + var EndpointApplicationCurrentDeployment = func(appID string) string + var EndpointApplicationCustomDomain = func(appID string) string + var EndpointApplicationDNS = func(appID string) string + var EndpointApplicationDeployWebhook = func(appID string) string + var EndpointApplicationDeployments = func(appID string) string + var EndpointApplicationDomains = func() string + var EndpointApplicationEnvs = func(appID string) string + var EndpointApplicationFileRead = func(appID string) string + var EndpointApplicationFiles = func(appID string) string + var EndpointApplicationGithubApp = func(appID string) string + var EndpointApplicationInformation = func(appID string) string + var EndpointApplicationListStatus = func() string + var EndpointApplicationLogs = func(appID string) string + var EndpointApplicationMetrics = func(appID string) string + var EndpointApplicationNetErrors = func(appID string) string + var EndpointApplicationNetLogs = func(appID string) string + var EndpointApplicationNetPerf = func(appID string) string + var EndpointApplicationPurgeCache = func(appID string) string + var EndpointApplicationRealtime = func(appID string) string + var EndpointApplicationRestart = func(appID string) string + var EndpointApplicationSnapshotRestore = func(appID string) string + var EndpointApplicationSnapshots = func(appID string) string + var EndpointApplicationStart = func(appID string) string + var EndpointApplicationStatus = func(appID string) string + var EndpointApplicationStop = func(appID string) string + var EndpointDatabaseCertificate = func(dbID string) string + var EndpointDatabaseCredentials = func(dbID string) string + var EndpointDatabaseInformation = func(dbID string) string + var EndpointDatabaseListStatus = func() string + var EndpointDatabaseMetrics = func(dbID string) string + var EndpointDatabaseSnapshotRestore = func(dbID string) string + var EndpointDatabaseSnapshots = func(dbID string) string + var EndpointDatabaseStart = func(dbID string) string + var EndpointDatabaseStatus = func(dbID string) string + var EndpointDatabaseStop = func(dbID string) string + var EndpointDatabases = func() string + var EndpointLoadBalancers = func() string + var EndpointServiceStatus = func() string + var EndpointUser = func() string + var EndpointUserSnapshots = func() string + var EndpointWorkspaceApplications = func() string + var EndpointWorkspaceInformation = func(workspaceID string) string + var EndpointWorkspaceInviteCode = func() string + var EndpointWorkspaceLeave = func() string + var EndpointWorkspaceMembers = func() string + var EndpointWorkspaces = func() string + func ErrorCode(err error) string + func IsRateLimit(err error) bool + type APIError struct + Code string + Message string + StatusCode int + func (e *APIError) Error() string + type Applications interface + ApplicationRealtime func(appID string, options ...RequestOpt) (*RealtimeStream, error) + CreateApplicationSnapshot func(appID string, options ...RequestOpt) (squarecloud.SnapshotCreated, error) + DeleteApplication func(appID string, options ...RequestOpt) error + DeleteApplicationEnvs func(appID string, keys []string, options ...RequestOpt) error + DeleteApplicationFile func(appID, path string, options ...RequestOpt) error + GetApplication func(appID string, options ...RequestOpt) (squarecloud.Application, error) + GetApplicationAnalytics func(appID string, start, end time.Time, options ...RequestOpt) (squarecloud.NetworkAnalytics, error) + GetApplicationCurrentDeployment func(appID string, options ...RequestOpt) (squarecloud.DeploymentCurrent, error) + GetApplicationDNS func(appID string, options ...RequestOpt) ([]squarecloud.DNSRecord, error) + GetApplicationDeployments func(appID string, options ...RequestOpt) ([][]squarecloud.Deployment, error) + GetApplicationDomains func(options ...RequestOpt) ([]squarecloud.AppDomain, error) + GetApplicationEnvs func(appID string, options ...RequestOpt) (squarecloud.EnvVars, error) + GetApplicationFiles func(appID, path string, options ...RequestOpt) ([]squarecloud.FileInfo, error) + GetApplicationListStatus func(options ...RequestOpt) ([]squarecloud.ApplicationStatusListItem, error) + GetApplicationLogs func(appID string, options ...RequestOpt) (squarecloud.ApplicationLogs, error) + GetApplicationMetrics func(appID string, options ...RequestOpt) ([]squarecloud.MetricPoint, error) + GetApplicationNetworkErrors func(appID string, start, end time.Time, options ...RequestOpt) (squarecloud.NetworkErrors, error) + GetApplicationNetworkLogs func(appID string, start, end time.Time, options ...RequestOpt) ([]squarecloud.NetworkLog, error) + GetApplicationNetworkPerformance func(appID string, start, end time.Time, options ...RequestOpt) (squarecloud.NetworkPerformance, error) + GetApplicationSnapshots func(appID string, options ...RequestOpt) ([]squarecloud.Snapshot, error) + GetApplicationStatus func(appID string, options ...RequestOpt) (squarecloud.ApplicationStatus, error) + GetApplicationStatusRaw func(appID string, options ...RequestOpt) (squarecloud.ApplicationStatusRaw, error) + GetApplications func(options ...RequestOpt) ([]squarecloud.UserApplication, error) + GetLoadBalancers func(options ...RequestOpt) (squarecloud.LoadBalancers, error) + LinkApplicationGithubApp func(appID, repositoryName, repositoryBranch string, options ...RequestOpt) (squarecloud.GithubAppLink, error) + MoveApplicationFile func(appID, path, to string, options ...RequestOpt) error + PostApplicationCommit func(appID string, reader io.Reader, options ...RequestOpt) error + PostApplicationDeployWebhook func(appID, accessToken string, options ...RequestOpt) (squarecloud.GithubWebhook, error) + PostApplicationSignal func(appID string, signal squarecloud.ApplicationSignal, options ...RequestOpt) error + PostApplications func(reader io.Reader, options ...RequestOpt) (*squarecloud.ApplicationUploaded, error) + PurgeApplicationCache func(appID string, options ...RequestOpt) error + PutApplicationFile func(appID, path string, content []byte, options ...RequestOpt) (squarecloud.FileWritten, error) + ReadApplicationFile func(appID, path string, options ...RequestOpt) (squarecloud.FileContent, error) + ReplaceApplicationEnvs func(appID string, envs squarecloud.EnvVars, options ...RequestOpt) (squarecloud.EnvVars, error) + RestoreApplicationSnapshot func(appID, snapshotID, versionID string, options ...RequestOpt) error + SetApplicationCustomDomain func(appID, domain string, options ...RequestOpt) error + SetApplicationEnvs func(appID string, envs squarecloud.EnvVars, options ...RequestOpt) (squarecloud.EnvVars, error) + UnlinkApplicationGithubApp func(appID string, options ...RequestOpt) error + func NewApplications(client Client) Applications + type Client interface + Close func() + HTTPClient func() *http.Client + Request func(method, url string, rqBody []byte, rsBody any, options ...RequestOpt) error + Stream func(method, url string, options ...RequestOpt) (io.ReadCloser, error) + func NewClient(token string, opts ...ConfigOpt) Client + type Config struct + HTTPClient *http.Client + Logger *slog.Logger + URL string + UserAgent string + func DefaultConfig() *Config + func (c *Config) Apply(opts []ConfigOpt) + type ConfigOpt func(config *Config) + func WithHTTPClient(httpClient *http.Client) ConfigOpt + func WithLogger(logger *slog.Logger) ConfigOpt + func WithURL(url string) ConfigOpt + func WithUserAgent(userAgent string) ConfigOpt + type Databases interface + CreateDatabase func(create squarecloud.DatabaseCreateOptions, options ...RequestOpt) (squarecloud.DatabaseCreated, error) + CreateDatabaseSnapshot func(dbID string, options ...RequestOpt) (squarecloud.SnapshotCreated, error) + DeleteDatabase func(dbID string, options ...RequestOpt) error + GetDatabase func(dbID string, options ...RequestOpt) (squarecloud.Database, error) + GetDatabaseCertificate func(dbID string, options ...RequestOpt) (squarecloud.DatabaseCertificate, error) + GetDatabaseListStatus func(options ...RequestOpt) ([]squarecloud.DatabaseStatusListItem, error) + GetDatabaseMetrics func(dbID string, options ...RequestOpt) ([]squarecloud.MetricPoint, error) + GetDatabaseSnapshots func(dbID string, options ...RequestOpt) ([]squarecloud.Snapshot, error) + GetDatabaseStatus func(dbID string, options ...RequestOpt) (squarecloud.DatabaseStatus, error) + GetDatabaseStatusRaw func(dbID string, options ...RequestOpt) (squarecloud.DatabaseStatusRaw, error) + GetDatabases func(options ...RequestOpt) ([]squarecloud.UserDatabase, error) + ResetDatabaseCredentials func(dbID string, reset squarecloud.DatabaseResetType, options ...RequestOpt) (squarecloud.DatabasePasswordReset, error) + RestoreDatabaseSnapshot func(dbID, snapshotID, versionID string, options ...RequestOpt) error + StartDatabase func(dbID string, options ...RequestOpt) error + StopDatabase func(dbID string, options ...RequestOpt) error + UpdateDatabase func(dbID string, update squarecloud.DatabaseUpdateOptions, options ...RequestOpt) error + func NewDatabases(client Client) Databases + type RealtimeStream struct + func (r *RealtimeStream) Close() error + func (r *RealtimeStream) Next() (squarecloud.RealtimeEvent, error) + type RequestConfig struct + Ctx context.Context + Request *http.Request + func DefaultRequestConfig(req *http.Request) *RequestConfig + func (c *RequestConfig) Apply(opts []RequestOpt) + type RequestOpt func(config *RequestConfig) + func WithContext(ctx context.Context) RequestOpt + func WithHeader(key string, value string) RequestOpt + func WithQueryParam(param string, value any) RequestOpt + func WithToken(token string) RequestOpt + type Rest interface + SelfUser func(opts ...RequestOpt) (squarecloud.User, error) + ServiceStatus func(opts ...RequestOpt) (squarecloud.ServiceStatus, error) + UserSnapshots func(scope squarecloud.SnapshotScope, opts ...RequestOpt) ([]squarecloud.Snapshot, error) + func New(client Client) Rest + type Workspaces interface + AddWorkspaceApplication func(workspaceID, appID string, options ...RequestOpt) error + AddWorkspaceMember func(workspaceID, code string, group squarecloud.WorkspaceMemberGroup, ...) error + CreateWorkspace func(name string, options ...RequestOpt) (squarecloud.WorkspaceCreated, error) + DeleteWorkspace func(workspaceID string, options ...RequestOpt) error + GetWorkspace func(workspaceID string, options ...RequestOpt) (squarecloud.Workspace, error) + GetWorkspaceInviteCode func(options ...RequestOpt) (squarecloud.WorkspaceInviteCode, error) + GetWorkspaces func(options ...RequestOpt) ([]squarecloud.Workspace, error) + LeaveWorkspace func(workspaceID string, options ...RequestOpt) error + RemoveWorkspaceApplication func(workspaceID, appID string, options ...RequestOpt) error + RemoveWorkspaceMember func(workspaceID, memberID string, options ...RequestOpt) error + UpdateWorkspaceMember func(workspaceID, memberID string, group squarecloud.WorkspaceMemberGroup, ...) error + func NewWorkspaces(client Client) Workspaces Other modules containing this package github.com/squarecloudofc/sdk-api-go
Go to main page