api

package

Go to main page

Versions in this module

v0

v0.7.1

Jan 26, 2026

Changes in this version

+ func RedactSensitiveData(data string) string

type Client

+ func (c *Client) PostOnlyOnce(ctx context.Context, path string, body interface{}) (*http.Response, error)

v0.7.0

Jan 20, 2026

Changes in this version

+ func IsUnauthorized(err error) bool

type Client

+ func (c *Client) SetTokenRefresher(refresher TokenRefresher)

type ClientOption

+ func WithTokenRefresher(refresher TokenRefresher) ClientOption

+ func WithUserAgent(userAgent string) ClientOption

+ type SessionTokenRefresher struct

+ func NewSessionTokenRefresher(getMachineToken func() (string, error), client *Client, ...) *SessionTokenRefresher

+ func (r *SessionTokenRefresher) RefreshToken(ctx context.Context) (string, error)

+ type SessionTokenRefresherOption func(*SessionTokenRefresher)

+ func WithOnTokenRefreshed(callback func(session *SessionResponse) error) SessionTokenRefresherOption

+ func WithRefreshLogger(logger Logger) SessionTokenRefresherOption

+ type TokenRefresher interface

+ RefreshToken func(ctx context.Context) (string, error)

v0.6.0

Jan 16, 2026

Changes in this version

type EnvironmentsService

+ func (s *EnvironmentsService) GetMetrics(ctx context.Context, siteIdentifier, envID, duration string) ([]*models.Metrics, error)

v0.5.0

Nov 28, 2025

Changes in this version

+ const DefaultBaseURL

+ const DefaultTimeout

+ const InitialBackoff

+ const MaxRetries

+ func DecodeResponse(resp *http.Response, target interface{}) error

+ func EnsureSiteUUID(ctx context.Context, client *Client, siteIdentifier string) (string, error)

+ func IsConflict(err error) bool

+ func IsNotFound(err error) bool

+ func IsUUID(s string) bool

+ func ResolveSiteNameToID(ctx context.Context, client *Client, siteName string) (string, error)

+ type AddTeamMemberRequest struct

+ Email string

+ Role string

+ type AuthService struct

+ func NewAuthService(client *Client) *AuthService

+ func (s *AuthService) Login(ctx context.Context, machineToken string) (*SessionResponse, error)

+ func (s *AuthService) ValidateSession(ctx context.Context, userID string) (bool, error)

+ func (s *AuthService) Whoami(ctx context.Context, userID string) (*models.User, error)

+ type BackupsService struct

+ func NewBackupsService(client *Client) *BackupsService

+ func (s *BackupsService) Create(ctx context.Context, siteID, envID string, req *CreateBackupRequest) (*models.Workflow, error)

+ func (s *BackupsService) CreateElement(ctx context.Context, siteID, envID, element string) (*models.Workflow, error)

+ func (s *BackupsService) Download(ctx context.Context, siteID, envID, backupID, element, outputPath string) error

+ func (s *BackupsService) Get(ctx context.Context, siteID, envID, backupID string) (*models.Backup, error)

+ func (s *BackupsService) GetDownloadURL(ctx context.Context, siteID, envID, backupID, element string) (string, error)

+ func (s *BackupsService) GetSchedule(ctx context.Context, siteID, envID string) (map[string]interface{}, error)

+ func (s *BackupsService) List(ctx context.Context, siteID, envID string) ([]*models.Backup, error)

+ func (s *BackupsService) Restore(ctx context.Context, siteID, envID, backupID string) (*models.Workflow, error)

+ func (s *BackupsService) SetSchedule(ctx context.Context, siteID, envID string, enabled bool, day int) error

+ type Client struct

+ func NewClient(options ...ClientOption) *Client

+ func (c *Client) Delete(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) Get(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) GetPaged(ctx context.Context, basePath string) ([]json.RawMessage, error)

+ func (c *Client) Patch(ctx context.Context, path string, body interface{}) (*http.Response, error)

+ func (c *Client) Post(ctx context.Context, path string, body interface{}) (*http.Response, error)

+ func (c *Client) Put(ctx context.Context, path string, body interface{}) (*http.Response, error)

+ func (c *Client) Request(ctx context.Context, method, path string, body interface{}) (*http.Response, error)

+ func (c *Client) SetToken(token string)

+ type ClientOption func(*Client)

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(httpClient *http.Client) ClientOption

+ func WithLogger(logger Logger) ClientOption

+ func WithToken(token string) ClientOption

+ type CloneContentRequest struct

+ Database bool

+ Files bool

+ FromEnvironment string

+ type CommitRequest struct

+ Message string

+ type CreateBackupRequest struct

+ KeepFor int

+ type CreateMultidevRequest struct

+ CloudDevelopmentEnvironmentID string

+ FromEnvironment string

+ type CreateSiteRequest struct

+ Label string

+ Organization string

+ Region string

+ SiteName string

+ UpstreamID string

+ type DefaultLogger struct

+ func NewLogger(verbosity VerbosityLevel) *DefaultLogger

+ func NewLoggerWithWriter(verbosity VerbosityLevel, w io.Writer) *DefaultLogger

+ func (l *DefaultLogger) Debug(msg string, args ...interface{})

+ func (l *DefaultLogger) Error(msg string, args ...interface{})

+ func (l *DefaultLogger) GetVerbosity() VerbosityLevel

+ func (l *DefaultLogger) Info(msg string, args ...interface{})

+ func (l *DefaultLogger) IsTraceEnabled() bool

+ func (l *DefaultLogger) LogHTTPRequest(method, url string, headers map[string][]string, body string)

+ func (l *DefaultLogger) LogHTTPResponse(statusCode int, status string, headers map[string][]string, body string)

+ func (l *DefaultLogger) Trace(msg string, args ...interface{})

+ func (l *DefaultLogger) Warn(msg string, args ...interface{})

+ type DeployRequest struct

+ ClearCache bool

+ Note string

+ UpdateDB bool

+ type DomainsService struct

+ func NewDomainsService(client *Client) *DomainsService

+ func (s *DomainsService) Add(ctx context.Context, siteID, envID, domain string) (*models.Domain, error)

+ func (s *DomainsService) Get(ctx context.Context, siteID, envID, domainID string) (*models.Domain, error)

+ func (s *DomainsService) GetDNS(ctx context.Context, siteID, envID, domainID string) ([]*models.DNSRecord, error)

+ func (s *DomainsService) List(ctx context.Context, siteID, envID string) ([]*models.Domain, error)

+ func (s *DomainsService) Remove(ctx context.Context, siteID, envID, domainID string) error

+ type EnvironmentsService struct

+ func NewEnvironmentsService(client *Client) *EnvironmentsService

+ func (s *EnvironmentsService) ApplyUpstreamUpdates(ctx context.Context, siteID, envID string, updateDB, acceptUpstream bool) (*models.Workflow, error)

+ func (s *EnvironmentsService) ChangeConnectionMode(ctx context.Context, siteID, envID, mode string) (*models.Workflow, error)

+ func (s *EnvironmentsService) ClearCache(ctx context.Context, siteID, envID string) (*models.Workflow, error)

+ func (s *EnvironmentsService) CloneContent(ctx context.Context, siteID, envID string, req *CloneContentRequest) (*models.Workflow, error)

+ func (s *EnvironmentsService) Commit(ctx context.Context, siteID, envID string, req *CommitRequest) (*models.Workflow, error)

+ func (s *EnvironmentsService) Deploy(ctx context.Context, siteID, envID string, req *DeployRequest) (*models.Workflow, error)

+ func (s *EnvironmentsService) Get(ctx context.Context, siteID, envID string) (*models.Environment, error)

+ func (s *EnvironmentsService) GetConnectionInfo(ctx context.Context, siteID, envID string) (*models.ConnectionInfo, error)

+ func (s *EnvironmentsService) GetLock(ctx context.Context, siteID, envID string) (*models.Lock, error)

+ func (s *EnvironmentsService) GetUpstreamUpdates(ctx context.Context, siteID, envID string) (*models.UpstreamUpdate, error)

+ func (s *EnvironmentsService) List(ctx context.Context, siteIdentifier string) ([]*models.Environment, error)

+ func (s *EnvironmentsService) RemoveLock(ctx context.Context, siteID, envID string) error

+ func (s *EnvironmentsService) SetLock(ctx context.Context, siteID, envID, username, password string) error

+ func (s *EnvironmentsService) Wipe(ctx context.Context, siteID, envID string) (*models.Workflow, error)

+ type Error struct

+ Message string

+ StatusCode int

+ func (e *Error) Error() string

+ type HTTPLogger interface

+ IsTraceEnabled func() bool

+ LogHTTPRequest func(method, url string, headers map[string][]string, body string)

+ LogHTTPResponse func(statusCode int, status string, headers map[string][]string, body string)

+ func AsHTTPLogger(logger Logger) (HTTPLogger, bool)

+ type Logger interface

+ Debug func(msg string, args ...interface{})

+ Error func(msg string, args ...interface{})

+ Info func(msg string, args ...interface{})

+ Warn func(msg string, args ...interface{})

+ type LoginRequest struct

+ Client string

+ MachineToken string

+ type MultidevService struct

+ func NewMultidevService(client *Client) *MultidevService

+ func (s *MultidevService) Create(ctx context.Context, siteID, envName, fromEnv string) (*models.Workflow, error)

+ func (s *MultidevService) Delete(ctx context.Context, siteID, envID string, deleteBranch bool) (*models.Workflow, error)

+ func (s *MultidevService) List(ctx context.Context, siteID string) ([]*models.Environment, error)

+ func (s *MultidevService) MergeFromDev(ctx context.Context, siteID, envID string, updateDB bool) (*models.Workflow, error)

+ func (s *MultidevService) MergeToDev(ctx context.Context, siteID, envID string, updateDB bool) (*models.Workflow, error)

+ type OrganizationsService struct

+ func NewOrganizationsService(client *Client) *OrganizationsService

+ func (s *OrganizationsService) Get(ctx context.Context, orgID string) (*models.Organization, error)

+ func (s *OrganizationsService) List(ctx context.Context, userID string) ([]*models.Organization, error)

+ func (s *OrganizationsService) ListMembers(ctx context.Context, orgID string) ([]*models.User, error)

+ func (s *OrganizationsService) ListUpstreams(ctx context.Context, orgID string) ([]*models.Upstream, error)

+ type RedisService struct

+ func NewRedisService(client *Client) *RedisService

+ func (s *RedisService) Disable(ctx context.Context, siteID string) (*models.Workflow, error)

+ func (s *RedisService) Enable(ctx context.Context, siteID string) (*models.Workflow, error)

+ type SessionResponse struct

+ ExpiresAt int64

+ Session string

+ UserID string

+ type SitesService struct

+ func NewSitesService(client *Client) *SitesService

+ func (s *SitesService) AddTag(ctx context.Context, siteIdentifier, orgID, tagName string) error

+ func (s *SitesService) AddTeamMember(ctx context.Context, siteIdentifier string, req *AddTeamMemberRequest) (*models.TeamMember, error)

+ func (s *SitesService) Create(ctx context.Context, userID string, req *CreateSiteRequest) (*models.Site, error)

+ func (s *SitesService) Delete(ctx context.Context, siteIdentifier string) error

+ func (s *SitesService) Get(ctx context.Context, siteIdentifier string) (*models.Site, error)

+ func (s *SitesService) GetPlan(ctx context.Context, siteIdentifier string) (*models.Plan, error)

+ func (s *SitesService) GetPlans(ctx context.Context, siteIdentifier string) ([]*models.Plan, error)

+ func (s *SitesService) GetTags(ctx context.Context, siteIdentifier, orgID string) ([]*models.Tag, error)

+ func (s *SitesService) GetTeam(ctx context.Context, siteIdentifier string) ([]*models.TeamMember, error)

+ func (s *SitesService) List(ctx context.Context, userID string) ([]*models.Site, error)

+ func (s *SitesService) ListBranches(ctx context.Context, siteIdentifier string) ([]*models.Branch, error)

+ func (s *SitesService) ListByOrganization(ctx context.Context, orgID string) ([]*models.Site, error)

+ func (s *SitesService) ListOrganizations(ctx context.Context, siteIdentifier string) ([]*models.SiteOrganizationMembership, error)

+ func (s *SitesService) RemoveTag(ctx context.Context, siteIdentifier, orgID, tagName string) error

+ func (s *SitesService) RemoveTeamMember(ctx context.Context, siteIdentifier, userID string) error

+ func (s *SitesService) Update(ctx context.Context, siteIdentifier string, req *UpdateRequest) (*models.Site, error)

+ type UpdateRequest struct

+ Label string

+ ServiceLevel string

+ type UpstreamsService struct

+ func NewUpstreamsService(client *Client) *UpstreamsService

+ func (s *UpstreamsService) Get(ctx context.Context, upstreamID string) (*models.Upstream, error)

+ func (s *UpstreamsService) List(ctx context.Context, userID string) ([]*models.Upstream, error)

+ func (s *UpstreamsService) ListUpdates(ctx context.Context, siteID, envID string) ([]*models.UpstreamUpdateCommit, error)

+ func (s *UpstreamsService) ResolveToID(ctx context.Context, upstreamIdentifier, userID string) (string, error)

+ type UsersService struct

+ func NewUsersService(client *Client) *UsersService

+ func (s *UsersService) ListMachineTokens(ctx context.Context, userID string) ([]*models.MachineToken, error)

+ func (s *UsersService) ListPaymentMethods(ctx context.Context, userID string) ([]*models.PaymentMethod, error)

+ func (s *UsersService) ListSSHKeys(ctx context.Context, userID string) ([]*models.SSHKey, error)

+ type VerbosityLevel int

+ const VerbosityDebug

+ const VerbosityInfo

+ const VerbosityNone

+ const VerbosityTrace

+ type WaitOptions struct

+ OnProgress func(*models.Workflow)

+ PollInterval time.Duration

+ Timeout time.Duration

+ func DefaultWaitOptions() *WaitOptions

+ type WatchOptions struct

+ OnUpdate func(*models.Workflow)

+ PollInterval time.Duration

+ type WorkflowsService struct

+ func NewWorkflowsService(client *Client) *WorkflowsService

+ func (s *WorkflowsService) CreateForSite(ctx context.Context, siteID, workflowType string, ...) (*models.Workflow, error)

+ func (s *WorkflowsService) CreateForUser(ctx context.Context, userID, workflowType string, ...) (*models.Workflow, error)

+ func (s *WorkflowsService) Get(ctx context.Context, siteID, workflowID string) (*models.Workflow, error)

+ func (s *WorkflowsService) GetForUser(ctx context.Context, userID, workflowID string) (*models.Workflow, error)

+ func (s *WorkflowsService) List(ctx context.Context, siteID string) ([]*models.Workflow, error)

+ func (s *WorkflowsService) ListForEnvironment(ctx context.Context, siteID, envID string) ([]*models.Workflow, error)

+ func (s *WorkflowsService) Wait(ctx context.Context, siteID, workflowID string, opts *WaitOptions) (*models.Workflow, error)

+ func (s *WorkflowsService) WaitForUser(ctx context.Context, userID, workflowID string, opts *WaitOptions) (*models.Workflow, error)

+ func (s *WorkflowsService) Watch(ctx context.Context, siteID, workflowID string, opts *WatchOptions) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL