Help us shape the future of Go! Take the 2026 Go Developer Survey

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

api

package

Go to main page

Versions in this module

v0

v0.1.0

Sep 20, 2026

Changes in this version

+ const ScopeAdmin

+ const ScopeDeploy

+ const ScopeRead

+ func GenerateBootstrapAdminToken(ctx context.Context, st *state.Store, note string) (string, error)

+ func RequiredScope(fullMethod string) (string, bool)

+ type AppsService struct

+ func NewAppsService(st *state.Store, box *secrets.Box, gitEndpoint string, ...) *AppsService

+ func (s *AppsService) DeleteApp(ctx context.Context, req *serverv1.DeleteAppRequest) (*serverv1.DeleteAppResponse, error)

+ func (s *AppsService) GetApp(ctx context.Context, req *serverv1.GetAppRequest) (*serverv1.GetAppResponse, error)

+ func (s *AppsService) ListApps(ctx context.Context, req *serverv1.ListAppsRequest) (*serverv1.ListAppsResponse, error)

+ func (s *AppsService) SetAppSource(ctx context.Context, req *serverv1.SetAppSourceRequest) (*serverv1.SetAppSourceResponse, error)

+ func (s *AppsService) SetAppWebhookSecret(ctx context.Context, req *serverv1.SetAppWebhookSecretRequest) (*serverv1.SetAppWebhookSecretResponse, error)

+ func (s *AppsService) ShowAppWebhook(ctx context.Context, req *serverv1.ShowAppWebhookRequest) (*serverv1.ShowAppWebhookResponse, error)

+ type Authenticator struct

+ func NewAuthenticator(st *state.Store) *Authenticator

+ func (a *Authenticator) Authenticate(ctx context.Context, authorization string) (Principal, error)

+ func (a *Authenticator) StreamAuthInterceptor() grpc.StreamServerInterceptor

+ func (a *Authenticator) UnaryAuthInterceptor() grpc.UnaryServerInterceptor

+ type BuildsService struct

+ func NewBuildsService(st *state.Store, queue *build.Queue) *BuildsService

+ func (s *BuildsService) GetBuild(ctx context.Context, req *serverv1.GetBuildRequest) (*serverv1.GetBuildResponse, error)

+ func (s *BuildsService) ListBuilds(ctx context.Context, req *serverv1.ListBuildsRequest) (*serverv1.ListBuildsResponse, error)

+ func (s *BuildsService) TriggerBuild(ctx context.Context, req *serverv1.TriggerBuildRequest) (*serverv1.TriggerBuildResponse, error)

+ type DeploymentsService struct

+ func NewDeploymentsService(st *state.Store, git GitDeployTriggers) *DeploymentsService

+ func (s *DeploymentsService) CancelDeployment(ctx context.Context, req *serverv1.CancelDeploymentRequest) (*serverv1.CancelDeploymentResponse, error)

+ func (s *DeploymentsService) Deploy(ctx context.Context, req *serverv1.DeployRequest) (*serverv1.DeployResponse, error)

+ func (s *DeploymentsService) DeployFromGit(ctx context.Context, req *serverv1.DeployFromGitRequest) (*serverv1.DeployFromGitResponse, error)

+ func (s *DeploymentsService) GetDeployment(ctx context.Context, req *serverv1.GetDeploymentRequest) (*serverv1.GetDeploymentResponse, error)

+ func (s *DeploymentsService) ListDeployments(ctx context.Context, req *serverv1.ListDeploymentsRequest) (*serverv1.ListDeploymentsResponse, error)

+ func (s *DeploymentsService) RollbackDeployment(ctx context.Context, req *serverv1.RollbackDeploymentRequest) (*serverv1.RollbackDeploymentResponse, error)

+ type DomainsService struct

+ func NewDomainsService(st *state.Store, mgr *ingress.Manager) *DomainsService

+ func (s *DomainsService) ListAppDomains(ctx context.Context, req *serverv1.ListAppDomainsRequest) (*serverv1.ListAppDomainsResponse, error)

+ func (s *DomainsService) VerifyAppDomains(ctx context.Context, req *serverv1.VerifyAppDomainsRequest) (*serverv1.VerifyAppDomainsResponse, error)

+ type DriftService struct

+ func NewDriftService(st *state.Store, eng *engine.Engine) *DriftService

+ func (s *DriftService) ConvergeDrift(ctx context.Context, req *serverv1.ConvergeDriftRequest) (*serverv1.ConvergeDriftResponse, error)

+ func (s *DriftService) SetDriftConverge(ctx context.Context, req *serverv1.SetDriftConvergeRequest) (*serverv1.SetDriftConvergeResponse, error)

+ func (s *DriftService) ShowDrift(ctx context.Context, req *serverv1.ShowDriftRequest) (*serverv1.ShowDriftResponse, error)

+ type EnvService struct

+ func NewEnvService(st *state.Store, box *secrets.Box) *EnvService

+ func (s *EnvService) GetEnv(ctx context.Context, req *serverv1.GetEnvRequest) (*serverv1.GetEnvResponse, error)

+ func (s *EnvService) ListEnv(ctx context.Context, req *serverv1.ListEnvRequest) (*serverv1.ListEnvResponse, error)

+ func (s *EnvService) RemoveEnv(ctx context.Context, req *serverv1.RemoveEnvRequest) (*serverv1.RemoveEnvResponse, error)

+ func (s *EnvService) SetEnv(ctx context.Context, req *serverv1.SetEnvRequest) (*serverv1.SetEnvResponse, error)

+ func (s *EnvService) WithEnvChangedHook(fn func(appID string)) *EnvService

+ type EventsService struct

+ func NewEventsService(st *state.Store) *EventsService

+ func (s *EventsService) WatchEvents(req *serverv1.WatchEventsRequest, ...) error

+ type GitDeployTriggers interface

+ DeployFromGitPush func(ctx context.Context, app, sha, ref, actorTokenID string) (state.DeployRecord, []compose.Warning, error)

+ type GitKeysService struct

+ func NewGitKeysService(st *state.Store) *GitKeysService

+ func (s *GitKeysService) AddGitKey(ctx context.Context, req *serverv1.AddGitKeyRequest) (*serverv1.AddGitKeyResponse, error)

+ func (s *GitKeysService) ListGitKeys(ctx context.Context, _ *serverv1.ListGitKeysRequest) (*serverv1.ListGitKeysResponse, error)

+ func (s *GitKeysService) RemoveGitKey(ctx context.Context, req *serverv1.RemoveGitKeyRequest) (*serverv1.RemoveGitKeyResponse, error)

+ type IngressStatusSource interface

+ Config func() ingress.Config

+ Status func(ctx context.Context) (ingress.Status, error)

+ type LogsService struct

+ func NewLogsService(st *state.Store, mg *logs.Manager) *LogsService

+ func (s *LogsService) FollowLogs(req *serverv1.FollowLogsRequest, stream serverv1.LogsService_FollowLogsServer) error

+ func (s *LogsService) ListHistoryLogs(ctx context.Context, req *serverv1.ListHistoryLogsRequest) (*serverv1.ListHistoryLogsResponse, error)

+ type PlacementService struct

+ func NewPlacementService(st *state.Store) *PlacementService

+ func (s *PlacementService) ShowPlacement(ctx context.Context, req *serverv1.ShowPlacementRequest) (*serverv1.ShowPlacementResponse, error)

+ type Principal struct

+ Scopes []string

+ TokenID string

+ func PrincipalFromContext(ctx context.Context) (Principal, bool)

+ type RevisionsService struct

+ func NewRevisionsService(st *state.Store) *RevisionsService

+ func (s *RevisionsService) GetRevisionSpec(ctx context.Context, req *serverv1.GetRevisionSpecRequest) (*serverv1.GetRevisionSpecResponse, error)

+ func (s *RevisionsService) ListRevisions(ctx context.Context, req *serverv1.ListRevisionsRequest) (*serverv1.ListRevisionsResponse, error)

+ type RouteWithdrawer interface

+ WithdrawAppRoutes func(ctx context.Context, appID string) error

+ type SystemComponent struct

+ Check func() error

+ Name string

+ type SystemService struct

+ func NewSystemService(version string, st *state.Store, components func() []SystemComponent, ...) *SystemService

+ func (s *SystemService) GetIngressStatus(ctx context.Context, req *serverv1.GetIngressStatusRequest) (*serverv1.GetIngressStatusResponse, error)

+ func (s *SystemService) GetSystemStatus(ctx context.Context, req *serverv1.GetSystemStatusRequest) (*serverv1.GetSystemStatusResponse, error)

+ func (s *SystemService) ListBackups(ctx context.Context, req *serverv1.ListBackupsRequest) (*serverv1.ListBackupsResponse, error)

+ func (s *SystemService) ListNodes(ctx context.Context, req *serverv1.ListNodesRequest) (*serverv1.ListNodesResponse, error)

+ func (s *SystemService) Ping(ctx context.Context, req *serverv1.PingRequest) (*serverv1.PingResponse, error)

+ func (s *SystemService) TriggerBackup(ctx context.Context, req *serverv1.TriggerBackupRequest) (*serverv1.TriggerBackupResponse, error)

+ func (s *SystemService) WithBackupManager(m *statebackup.Manager) *SystemService

+ type TokensService struct

+ func NewTokensService(st *state.Store) *TokensService

+ func (s *TokensService) CreateToken(ctx context.Context, req *serverv1.CreateTokenRequest) (*serverv1.CreateTokenResponse, error)

+ func (s *TokensService) ListTokens(ctx context.Context, _ *serverv1.ListTokensRequest) (*serverv1.ListTokensResponse, error)

+ func (s *TokensService) RevokeToken(ctx context.Context, req *serverv1.RevokeTokenRequest) (*serverv1.RevokeTokenResponse, error)

v0.1.0-rc1

Sep 19, 2026