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
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

v1

v1.20.0

Jun 4, 2026

v1.19.5

May 25, 2026

v1.19.4

May 18, 2026

v1.19.3

May 17, 2026

v1.19.2

May 17, 2026

v1.19.1

May 13, 2026

Changes in this version

+ func RegisterDiagnosticsRoutes(group *echo.Group, authMiddleware *middleware.AuthMiddleware, ...)

+ func RegisterWebhookTrigger(g *echo.Group, webhookService *services.WebhookService)

+ func SetupAPI(e *echo.Echo, apiGroup *echo.Group, cfg *config.Config, svc *Services) huma.API

+ func SetupAPIForSpec() huma.API

+ type DiagnosticsHandler struct

+ func (h *DiagnosticsHandler) WebSocketDiagnostics(c echo.Context) error

+ type Services struct

+ ApiKey *services.ApiKeyService

+ AppImages *services.ApplicationImagesService

+ Apprise *services.AppriseService

+ Auth *services.AuthService

+ Build *services.BuildService

+ BuildWorkspace *services.BuildWorkspaceService

+ Config *config.Config

+ Container *services.ContainerService

+ ContainerRegistry *services.ContainerRegistryService

+ CustomizeSearch *services.CustomizeSearchService

+ Dashboard *services.DashboardService

+ Docker *services.DockerClientService

+ Environment *services.EnvironmentService

+ Event *services.EventService

+ Font *services.FontService

+ GitOpsSync *services.GitOpsSyncService

+ GitRepository *services.GitRepositoryService

+ Image *services.ImageService

+ ImageUpdate *services.ImageUpdateService

+ JobSchedule *services.JobService

+ Network *services.NetworkService

+ Notification *services.NotificationService

+ Oidc *services.OidcService

+ Port *services.PortService

+ Project *services.ProjectService

+ Settings *services.SettingsService

+ SettingsSearch *services.SettingsSearchService

+ Swarm *services.SwarmService

+ System *services.SystemService

+ SystemUpgrade *services.SystemUpgradeService

+ Template *services.TemplateService

+ Updater *services.UpdaterService

+ User *services.UserService

+ Version *services.VersionService

+ Volume *services.VolumeService

+ Vulnerability *services.VulnerabilityService

+ Webhook *services.WebhookService