Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

remote

package

Go to main page

Versions in this module

v1

v1.4.0

Jun 14, 2026

v1.3.0

Jan 10, 2026

v1.2.1

Oct 21, 2025

v1.2.0

Oct 15, 2025

Changes in this version

type Client

+ ReportJobCompletion func(ctx context.Context, jobID string, data map[string]interface{}) error

v1.1.0

Sep 25, 2025

v1.0.0

Sep 25, 2025

Changes in this version

+ const ProcessStopCommand

+ const ProcessStopNativeStop

+ const ProcessStopSignal

+ const SftpAuthPassword

+ const SftpAuthPublicKey

+ func IsRequestError(err error) bool

+ type BackupPart struct

+ ETag string

+ PartNumber int

+ type BackupRemoteUploadResponse struct

+ PartSize int64

+ Parts []string

+ type BackupRequest struct

+ Checksum string

+ ChecksumType string

+ Parts []BackupPart

+ Size int64

+ SnapshotId string

+ Successful bool

+ type BackupSizeRecalculation struct

+ BackupUuid string

+ NewSize int64

+ type Client interface

+ DeleteBackup func(ctx context.Context, backup string) error

+ GetBackupRemoteUploadURLs func(ctx context.Context, backup string, size int64) (BackupRemoteUploadResponse, error)

+ GetInstallationScript func(ctx context.Context, uuid string) (InstallationScript, error)

+ GetServerConfiguration func(ctx context.Context, uuid string) (ServerConfigurationResponse, error)

+ GetServerRusticConfig func(ctx context.Context, serverUuid string, backupType string) (RusticBackupRequest, error)

+ GetServers func(context context.Context, perPage int) ([]RawServerData, error)

+ ResetServersState func(ctx context.Context) error

+ SendActivityLogs func(ctx context.Context, activity []models.Activity) error

+ SendRestorationStatus func(ctx context.Context, backup string, successful bool) error

+ SetArchiveStatus func(ctx context.Context, uuid string, successful bool) error

+ SetBackupStatus func(ctx context.Context, backup string, data BackupRequest) error

+ SetInstallationStatus func(ctx context.Context, uuid string, data InstallStatusRequest) error

+ SetTransferStatus func(ctx context.Context, uuid string, successful bool) error

+ UpdateBackupSizes func(ctx context.Context, data RecalculatedBackupSizesRequest) error

+ ValidateSftpCredentials func(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error)

+ func New(base string, opts ...ClientOption) Client

+ type ClientOption func(c *client)

+ func WithCredentials(id, token string) ClientOption

+ func WithHttpClient(httpClient *http.Client) ClientOption

+ type InstallStatusRequest struct

+ Reinstall bool

+ Successful bool

+ type InstallationScript struct

+ ContainerImage string

+ Entrypoint string

+ Script string

+ type OutputLineMatcher struct

+ func (olm *OutputLineMatcher) Matches(s []byte) bool

+ func (olm *OutputLineMatcher) String() string

+ func (olm *OutputLineMatcher) UnmarshalJSON(data []byte) error

+ type Pagination struct

+ CurrentPage uint

+ From uint

+ LastPage uint

+ PerPage uint

+ To uint

+ Total uint

+ type ProcessConfiguration struct

+ ConfigurationFiles []parser.ConfigurationFile

+ Startup struct{ ... }

+ Stop ProcessStopConfiguration

+ type ProcessStopConfiguration struct

+ Type string

+ Value string

+ type RawServerData struct

+ ProcessConfiguration json.RawMessage

+ Settings json.RawMessage

+ Uuid string

+ type RecalculatedBackupSizesRequest struct

+ Backups []BackupSizeRecalculation

+ ServerUuid string

+ type RequestError struct

+ Code string

+ Detail string

+ Status string

+ func AsRequestError(err error) *RequestError

+ func (re *RequestError) Error() string

+ func (re *RequestError) StatusCode() int

+ type RequestErrors struct

+ Errors []RequestError

+ type Response struct

+ func (r *Response) BindJSON(v interface{}) error

+ func (r *Response) Error() error

+ func (r *Response) HasError() bool

+ func (r *Response) Read() ([]byte, error)

+ type RusticBackupRequest struct

+ BackupType string

+ RepositoryPassword string

+ RepositoryPath string

+ S3Credentials *S3Credentials

+ type S3Credentials struct

+ AccessKeyID string

+ Bucket string

+ CACertPath string

+ DisableSSL bool

+ Endpoint string

+ ForcePathStyle bool

+ KeyPrefix string

+ Region string

+ SecretAccessKey string

+ SessionToken string

+ type ServerConfigurationResponse struct

+ ProcessConfiguration *ProcessConfiguration

+ Settings json.RawMessage

+ type SftpAuthRequest struct

+ ClientVersion []byte

+ IP string

+ Pass string

+ SessionID []byte

+ Type SftpAuthRequestType

+ User string

+ type SftpAuthRequestType string

+ type SftpAuthResponse struct

+ Permissions []string

+ Server string

+ User string

+ type SftpInvalidCredentialsError struct

+ func (ice SftpInvalidCredentialsError) Error() string