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

Oct 15, 2026

Changes in this version

+ type ActivityEvent struct

+ Action string

+ CreatedAt int64

+ ID string

+ Message string

+ ResourceID string

+ ResourceName string

+ ResourceType string

+ ServiceID string

+ Status string

+ type BootstrapTokenValidateRequest struct

+ Token string

+ type BootstrapTokenValidateResponse struct

+ Valid bool

+ type CreateKeyRequest struct

+ ExpiresIn *int64

+ Name string

+ type CreateKeyResponse struct

+ APIKey string

+ Expires *int64

+ ID string

+ Name string

+ Prefix string

+ type DetailedHealthResponse struct

+ Disk DiskInfo

+ Docker DockerInfo

+ DockerDisk DiskInfo

+ DockerStorage *DockerStorageInfo

+ GVisor GVisorInfo

+ Status string

+ TraefikNetworks *int

+ type DiskInfo struct

+ FreeGB float64

+ TotalGB float64

+ UsedPercent float64

+ type DockerInfo struct

+ Available bool

+ Version string

+ type DockerStorageInfo struct

+ BuildCacheSizeBytes int64

+ ContainersSizeBytes int64

+ ImagesSizeBytes int64

+ TotalSizeGB float64

+ VolumesSizeBytes int64

+ type GVisorInfo struct

+ Available bool

+ Version string

+ type HealthResponse struct

+ Status string

+ type KeyInfo struct

+ CreatedAt int64

+ ExpiresAt *int64

+ ID string

+ LastUsedAt *int64

+ Name string

+ Prefix string

+ type KeyRecoverRequest struct

+ BootstrapToken string

+ Email string

+ type KeyRecoverResponse struct

+ CreatedAt int64

+ ID string

+ Key string

+ Name string

+ RevokedKeyID string

+ Warning string

+ type QuotaUpdateRequest struct

+ MaxBuildsConcurrent *int

+ MaxDatabases *int

+ MaxEnvVarsPerService *int

+ MaxServices *int

+ type QuotaUpdateResponse struct

+ APIRateLimit int

+ MaxBuildsConcurrent int

+ MaxCPUCores float64

+ MaxDatabases int

+ MaxDiskGB int

+ MaxEnvVarsPerService int

+ MaxMemoryMB int

+ MaxServices int

+ TenantID string

+ type ReactivateResponse struct

+ APIKey string

+ Status string

+ TenantID string

+ type RegisterRequest struct

+ Email string

+ Name string

+ type RegisterResponse struct

+ APIKey string

+ TenantID string

+ type Server struct

+ func NewServer(cfg ServerConfig) *Server

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ServerConfig struct

+ AdminTokens []string

+ BaseDomain string

+ BootstrapTokens []string

+ BuildManager *builds.Manager

+ DataDir string

+ DatabaseManager databaseManager

+ DeploymentStore *deployments.Store

+ DevMode bool

+ Docker docker.Client

+ EnvironmentManager *environments.Manager

+ ExternalTLSTerminated bool

+ KanbanManager kanbanManager

+ MasterKey []byte

+ MeteringStore *metering.Store

+ OpenRegistration bool

+ Store *db.Store

+ TraefikConfigDir string

+ type TenantResponse struct

+ CreatedAt int64

+ Email string

+ ID string

+ Name string

+ Status string

+ UpdatedAt int64

+ type TenantUsageBucket struct

+ Max int

+ Used int

+ type TenantUsageResponse struct

+ APIKeys TenantUsageBucket

+ CPUCores float64

+ Databases TenantUsageBucket

+ DiskGB int

+ MemoryMB int

+ RateLimit int

+ Services TenantUsageBucket

+ type UpdateTenantRequest struct

+ Name *string

v0.5.0

Mar 30, 2026

v0.4.0

Mar 20, 2026