Documentation
¶
Index ¶
- type ApplicationService
- func (s *ApplicationService) BulkUpdateEnvs(ctx context.Context, appUUID string, req *BulkUpdateEnvsRequest) (*BulkUpdateEnvsResponse, error)
- func (s *ApplicationService) CreateEnv(ctx context.Context, uuid string, req *models.EnvironmentVariableCreateRequest) (*models.EnvironmentVariable, error)
- func (s *ApplicationService) Delete(ctx context.Context, uuid string) error
- func (s *ApplicationService) DeleteEnv(ctx context.Context, appUUID string, envUUID string) error
- func (s *ApplicationService) Get(ctx context.Context, uuid string) (*models.Application, error)
- func (s *ApplicationService) GetEnv(ctx context.Context, appUUID, envIdentifier string) (*models.EnvironmentVariable, error)
- func (s *ApplicationService) List(ctx context.Context) ([]models.Application, error)
- func (s *ApplicationService) ListEnvs(ctx context.Context, uuid string) ([]models.EnvironmentVariable, error)
- func (s *ApplicationService) Logs(ctx context.Context, uuid string, lines int) (*models.ApplicationLogsResponse, error)
- func (s *ApplicationService) Restart(ctx context.Context, uuid string) (*models.ApplicationLifecycleResponse, error)
- func (s *ApplicationService) Start(ctx context.Context, uuid string, force bool, instantDeploy bool) (*models.ApplicationLifecycleResponse, error)
- func (s *ApplicationService) Stop(ctx context.Context, uuid string) (*models.ApplicationLifecycleResponse, error)
- func (s *ApplicationService) Update(ctx context.Context, uuid string, req models.ApplicationUpdateRequest) (*models.Application, error)
- func (s *ApplicationService) UpdateEnv(ctx context.Context, appUUID string, ...) (*models.EnvironmentVariable, error)
- type BulkUpdateEnvsRequest
- type BulkUpdateEnvsResponse
- type CancelResponse
- type DatabaseService
- func (s *DatabaseService) Create(ctx context.Context, dbType string, req *models.DatabaseCreateRequest) (*models.Database, error)
- func (s *DatabaseService) CreateBackup(ctx context.Context, uuid string, req *models.DatabaseBackupCreateRequest) (*models.DatabaseBackup, error)
- func (s *DatabaseService) Delete(ctx context.Context, uuid string, ...) error
- func (s *DatabaseService) DeleteBackup(ctx context.Context, dbUUID, backupUUID string, deleteS3 bool) error
- func (s *DatabaseService) DeleteBackupExecution(ctx context.Context, dbUUID, backupUUID, executionUUID string, deleteS3 bool) error
- func (s *DatabaseService) Get(ctx context.Context, uuid string) (*models.Database, error)
- func (s *DatabaseService) List(ctx context.Context) ([]models.Database, error)
- func (s *DatabaseService) ListBackupExecutions(ctx context.Context, dbUUID, backupUUID string) ([]models.DatabaseBackupExecution, error)
- func (s *DatabaseService) ListBackups(ctx context.Context, uuid string) ([]models.DatabaseBackup, error)
- func (s *DatabaseService) Restart(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
- func (s *DatabaseService) Start(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
- func (s *DatabaseService) Stop(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
- func (s *DatabaseService) Update(ctx context.Context, uuid string, req *models.DatabaseUpdateRequest) error
- func (s *DatabaseService) UpdateBackup(ctx context.Context, dbUUID, backupUUID string, ...) error
- type DeployResponse
- type DeploymentInfo
- type DeploymentService
- func (s *DeploymentService) Cancel(ctx context.Context, uuid string) (*CancelResponse, error)
- func (s *DeploymentService) Deploy(ctx context.Context, uuid string, force bool) (*DeployResponse, error)
- func (s *DeploymentService) Get(ctx context.Context, uuid string) (*models.Deployment, error)
- func (s *DeploymentService) GetLogsByApplication(ctx context.Context, appUUID string, lines int) (string, error)
- func (s *DeploymentService) GetLogsByApplicationWithFormat(ctx context.Context, appUUID string, take int, showHidden bool, format string) (string, error)
- func (s *DeploymentService) GetLogsByApplicationWithOptions(ctx context.Context, appUUID string, take int, showHidden bool) (string, error)
- func (s *DeploymentService) GetLogsByDeployment(ctx context.Context, deploymentUUID string) (string, error)
- func (s *DeploymentService) GetLogsByDeploymentWithFormat(ctx context.Context, deploymentUUID string, showHidden bool, format string) (string, error)
- func (s *DeploymentService) GetLogsByDeploymentWithOptions(ctx context.Context, deploymentUUID string, showHidden bool) (string, error)
- func (s *DeploymentService) List(ctx context.Context) ([]models.Deployment, error)
- func (s *DeploymentService) ListByApplication(ctx context.Context, appUUID string) ([]models.Deployment, error)
- func (s *DeploymentService) ListByApplicationWithPagination(ctx context.Context, appUUID string, skip, take int) ([]models.Deployment, error)
- type DeploymentsListResponse
- type GitHubAppService
- func (s *GitHubAppService) Create(ctx context.Context, req *models.GitHubAppCreateRequest) (*models.GitHubApp, error)
- func (s *GitHubAppService) Delete(ctx context.Context, uuid string) error
- func (s *GitHubAppService) Get(ctx context.Context, uuid string) (*models.GitHubApp, error)
- func (s *GitHubAppService) List(ctx context.Context) ([]models.GitHubApp, error)
- func (s *GitHubAppService) ListBranches(ctx context.Context, appUUID string, owner, repo string) ([]models.GitHubBranch, error)
- func (s *GitHubAppService) ListRepositories(ctx context.Context, appUUID string) ([]models.GitHubRepository, error)
- func (s *GitHubAppService) Update(ctx context.Context, uuid string, req *models.GitHubAppUpdateRequest) error
- type PrivateKeyService
- type ProjectService
- type ResourceService
- type ServerService
- func (s *ServerService) Create(ctx context.Context, req models.ServerCreateRequest) (*models.Response, error)
- func (s *ServerService) Delete(ctx context.Context, uuid string) error
- func (s *ServerService) Get(ctx context.Context, uuid string) (*models.Server, error)
- func (s *ServerService) GetDomains(ctx context.Context, uuid string) ([]models.Domain, error)
- func (s *ServerService) GetResources(ctx context.Context, uuid string) (*models.Resources, error)
- func (s *ServerService) List(ctx context.Context) ([]models.Server, error)
- func (s *ServerService) Validate(ctx context.Context, uuid string) (*models.Response, error)
- type Service
- func (s *Service) BulkUpdateEnvs(ctx context.Context, serviceUUID string, ...) (*models.ServiceEnvBulkUpdateResponse, error)
- func (s *Service) Create(ctx context.Context, req *models.ServiceCreateRequest) (*models.Service, error)
- func (s *Service) CreateEnv(ctx context.Context, uuid string, ...) (*models.ServiceEnvironmentVariable, error)
- func (s *Service) Delete(ctx context.Context, uuid string, ...) error
- func (s *Service) DeleteEnv(ctx context.Context, serviceUUID, envUUID string) error
- func (s *Service) Get(ctx context.Context, uuid string) (*models.Service, error)
- func (s *Service) GetEnv(ctx context.Context, serviceUUID, envIdentifier string) (*models.ServiceEnvironmentVariable, error)
- func (s *Service) List(ctx context.Context) ([]models.Service, error)
- func (s *Service) ListEnvs(ctx context.Context, uuid string) ([]models.ServiceEnvironmentVariable, error)
- func (s *Service) Restart(ctx context.Context, uuid string) (*models.ServiceLifecycleResponse, error)
- func (s *Service) Start(ctx context.Context, uuid string) (*models.ServiceLifecycleResponse, error)
- func (s *Service) Stop(ctx context.Context, uuid string) (*models.ServiceLifecycleResponse, error)
- func (s *Service) Update(ctx context.Context, uuid string, req *models.ServiceUpdateRequest) (*models.Service, error)
- func (s *Service) UpdateEnv(ctx context.Context, serviceUUID string, ...) (*models.ServiceEnvironmentVariable, error)
- type TeamService
- func (s *TeamService) Current(ctx context.Context) (*models.Team, error)
- func (s *TeamService) CurrentMembers(ctx context.Context) ([]models.TeamMember, error)
- func (s *TeamService) Get(ctx context.Context, id string) (*models.Team, error)
- func (s *TeamService) List(ctx context.Context) ([]models.Team, error)
- func (s *TeamService) ListMembers(ctx context.Context, teamID string) ([]models.TeamMember, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationService ¶
type ApplicationService struct {
// contains filtered or unexported fields
}
ApplicationService handles application-related operations
func NewApplicationService ¶
func NewApplicationService(client *api.Client) *ApplicationService
NewApplicationService creates a new application service
func (*ApplicationService) BulkUpdateEnvs ¶
func (s *ApplicationService) BulkUpdateEnvs(ctx context.Context, appUUID string, req *BulkUpdateEnvsRequest) (*BulkUpdateEnvsResponse, error)
BulkUpdateEnvs updates multiple environment variables in a single request
func (*ApplicationService) CreateEnv ¶
func (s *ApplicationService) CreateEnv(ctx context.Context, uuid string, req *models.EnvironmentVariableCreateRequest) (*models.EnvironmentVariable, error)
CreateEnv creates a new environment variable for an application
func (*ApplicationService) Delete ¶
func (s *ApplicationService) Delete(ctx context.Context, uuid string) error
Delete deletes an application
func (*ApplicationService) DeleteEnv ¶
DeleteEnv deletes an environment variable from an application
func (*ApplicationService) Get ¶
func (s *ApplicationService) Get(ctx context.Context, uuid string) (*models.Application, error)
Get retrieves a specific application by UUID
func (*ApplicationService) GetEnv ¶
func (s *ApplicationService) GetEnv(ctx context.Context, appUUID, envIdentifier string) (*models.EnvironmentVariable, error)
GetEnv retrieves a single environment variable by UUID or key
func (*ApplicationService) List ¶
func (s *ApplicationService) List(ctx context.Context) ([]models.Application, error)
List retrieves all applications
func (*ApplicationService) ListEnvs ¶
func (s *ApplicationService) ListEnvs(ctx context.Context, uuid string) ([]models.EnvironmentVariable, error)
ListEnvs retrieves all environment variables for an application
func (*ApplicationService) Logs ¶
func (s *ApplicationService) Logs(ctx context.Context, uuid string, lines int) (*models.ApplicationLogsResponse, error)
Logs retrieves logs for an application
func (*ApplicationService) Restart ¶
func (s *ApplicationService) Restart(ctx context.Context, uuid string) (*models.ApplicationLifecycleResponse, error)
Restart restarts an application
func (*ApplicationService) Start ¶
func (s *ApplicationService) Start(ctx context.Context, uuid string, force bool, instantDeploy bool) (*models.ApplicationLifecycleResponse, error)
Start starts an application (initiates deployment)
func (*ApplicationService) Stop ¶
func (s *ApplicationService) Stop(ctx context.Context, uuid string) (*models.ApplicationLifecycleResponse, error)
Stop stops an application
func (*ApplicationService) Update ¶
func (s *ApplicationService) Update(ctx context.Context, uuid string, req models.ApplicationUpdateRequest) (*models.Application, error)
Update updates an application
func (*ApplicationService) UpdateEnv ¶
func (s *ApplicationService) UpdateEnv(ctx context.Context, appUUID string, req *models.EnvironmentVariableUpdateRequest) (*models.EnvironmentVariable, error)
UpdateEnv updates an existing environment variable for an application
type BulkUpdateEnvsRequest ¶
type BulkUpdateEnvsRequest struct {
Data []models.EnvironmentVariableCreateRequest `json:"data"`
}
BulkUpdateEnvsRequest represents a bulk update request for environment variables
type BulkUpdateEnvsResponse ¶
type BulkUpdateEnvsResponse struct {
Message string `json:"message"`
}
BulkUpdateEnvsResponse represents the response from bulk update
type CancelResponse ¶
type CancelResponse struct {
Message string `json:"message"`
DeploymentUUID string `json:"deployment_uuid"`
Status string `json:"status"`
}
CancelResponse represents the response from canceling a deployment
type DatabaseService ¶
type DatabaseService struct {
// contains filtered or unexported fields
}
DatabaseService handles database-related operations
func NewDatabaseService ¶
func NewDatabaseService(client *api.Client) *DatabaseService
NewDatabaseService creates a new database service
func (*DatabaseService) Create ¶
func (s *DatabaseService) Create(ctx context.Context, dbType string, req *models.DatabaseCreateRequest) (*models.Database, error)
Create creates a new database of the specified type
func (*DatabaseService) CreateBackup ¶
func (s *DatabaseService) CreateBackup(ctx context.Context, uuid string, req *models.DatabaseBackupCreateRequest) (*models.DatabaseBackup, error)
CreateBackup creates a new scheduled backup configuration Note: This endpoint will be available in a future version of Coolify
func (*DatabaseService) Delete ¶
func (s *DatabaseService) Delete(ctx context.Context, uuid string, deleteConfigurations, deleteVolumes, dockerCleanup, deleteConnectedNetworks bool) error
Delete deletes a database
func (*DatabaseService) DeleteBackup ¶
func (s *DatabaseService) DeleteBackup(ctx context.Context, dbUUID, backupUUID string, deleteS3 bool) error
DeleteBackup deletes a backup configuration
func (*DatabaseService) DeleteBackupExecution ¶
func (s *DatabaseService) DeleteBackupExecution(ctx context.Context, dbUUID, backupUUID, executionUUID string, deleteS3 bool) error
DeleteBackupExecution deletes a specific backup execution
func (*DatabaseService) ListBackupExecutions ¶
func (s *DatabaseService) ListBackupExecutions(ctx context.Context, dbUUID, backupUUID string) ([]models.DatabaseBackupExecution, error)
ListBackupExecutions retrieves all executions for a backup configuration
func (*DatabaseService) ListBackups ¶
func (s *DatabaseService) ListBackups(ctx context.Context, uuid string) ([]models.DatabaseBackup, error)
ListBackups retrieves all backup configurations for a database
func (*DatabaseService) Restart ¶
func (s *DatabaseService) Restart(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
Restart restarts a database
func (*DatabaseService) Start ¶
func (s *DatabaseService) Start(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
Start starts a database
func (*DatabaseService) Stop ¶
func (s *DatabaseService) Stop(ctx context.Context, uuid string) (*models.DatabaseLifecycleResponse, error)
Stop stops a database
func (*DatabaseService) Update ¶
func (s *DatabaseService) Update(ctx context.Context, uuid string, req *models.DatabaseUpdateRequest) error
Update updates a database
func (*DatabaseService) UpdateBackup ¶
func (s *DatabaseService) UpdateBackup(ctx context.Context, dbUUID, backupUUID string, req *models.DatabaseBackupUpdateRequest) error
UpdateBackup updates a backup configuration
type DeployResponse ¶
type DeployResponse struct {
Deployments []DeploymentInfo `json:"deployments"`
}
DeployResponse represents the response from a deploy operation
type DeploymentInfo ¶
type DeploymentInfo struct {
Message string `json:"message"`
ResourceUUID string `json:"resource_uuid"`
DeploymentUUID string `json:"deployment_uuid"`
}
DeploymentInfo represents a single deployment in the deploy response
type DeploymentService ¶
type DeploymentService struct {
// contains filtered or unexported fields
}
DeploymentService handles deployment-related operations
func NewDeploymentService ¶
func NewDeploymentService(client *api.Client) *DeploymentService
NewDeploymentService creates a new deployment service
func (*DeploymentService) Cancel ¶
func (s *DeploymentService) Cancel(ctx context.Context, uuid string) (*CancelResponse, error)
Cancel cancels an in-progress deployment Note: This endpoint will be available in a future version of Coolify
func (*DeploymentService) Deploy ¶
func (s *DeploymentService) Deploy(ctx context.Context, uuid string, force bool) (*DeployResponse, error)
Deploy triggers a deployment for a resource
func (*DeploymentService) Get ¶
func (s *DeploymentService) Get(ctx context.Context, uuid string) (*models.Deployment, error)
Get retrieves a deployment by UUID
func (*DeploymentService) GetLogsByApplication ¶
func (s *DeploymentService) GetLogsByApplication(ctx context.Context, appUUID string, lines int) (string, error)
GetLogsByApplication retrieves deployment logs for a specific application This gets the latest deployment and returns its logs
func (*DeploymentService) GetLogsByApplicationWithFormat ¶
func (s *DeploymentService) GetLogsByApplicationWithFormat(ctx context.Context, appUUID string, take int, showHidden bool, format string) (string, error)
GetLogsByApplicationWithFormat retrieves deployment logs with format control
func (*DeploymentService) GetLogsByApplicationWithOptions ¶
func (s *DeploymentService) GetLogsByApplicationWithOptions(ctx context.Context, appUUID string, take int, showHidden bool) (string, error)
GetLogsByApplicationWithOptions retrieves deployment logs for a specific application with formatting options
func (*DeploymentService) GetLogsByDeployment ¶
func (s *DeploymentService) GetLogsByDeployment(ctx context.Context, deploymentUUID string) (string, error)
GetLogsByDeployment retrieves logs for a specific deployment by UUID
func (*DeploymentService) GetLogsByDeploymentWithFormat ¶
func (s *DeploymentService) GetLogsByDeploymentWithFormat(ctx context.Context, deploymentUUID string, showHidden bool, format string) (string, error)
GetLogsByDeploymentWithFormat retrieves logs with format control (json/pretty/table)
func (*DeploymentService) GetLogsByDeploymentWithOptions ¶
func (s *DeploymentService) GetLogsByDeploymentWithOptions(ctx context.Context, deploymentUUID string, showHidden bool) (string, error)
GetLogsByDeploymentWithOptions retrieves logs for a specific deployment by UUID with formatting options
func (*DeploymentService) List ¶
func (s *DeploymentService) List(ctx context.Context) ([]models.Deployment, error)
List retrieves all deployments
func (*DeploymentService) ListByApplication ¶
func (s *DeploymentService) ListByApplication(ctx context.Context, appUUID string) ([]models.Deployment, error)
ListByApplication retrieves all deployments for a specific application
func (*DeploymentService) ListByApplicationWithPagination ¶
func (s *DeploymentService) ListByApplicationWithPagination(ctx context.Context, appUUID string, skip, take int) ([]models.Deployment, error)
ListByApplicationWithPagination retrieves deployments with pagination support
type DeploymentsListResponse ¶
type DeploymentsListResponse struct {
Count int `json:"count"`
Deployments []models.Deployment `json:"deployments"`
}
DeploymentsListResponse represents the response from listing deployments
type GitHubAppService ¶
type GitHubAppService struct {
// contains filtered or unexported fields
}
GitHubAppService handles GitHub App-related operations
func NewGitHubAppService ¶
func NewGitHubAppService(client *api.Client) *GitHubAppService
NewGitHubAppService creates a new GitHub App service
func (*GitHubAppService) Create ¶
func (s *GitHubAppService) Create(ctx context.Context, req *models.GitHubAppCreateRequest) (*models.GitHubApp, error)
Create creates a new GitHub App
func (*GitHubAppService) Delete ¶
func (s *GitHubAppService) Delete(ctx context.Context, uuid string) error
Delete deletes a GitHub App
func (*GitHubAppService) Get ¶
Get retrieves a specific GitHub App by UUID Note: This endpoint will be available in a future version of Coolify
func (*GitHubAppService) List ¶
List retrieves all GitHub Apps Note: This endpoint will be available in a future version of Coolify
func (*GitHubAppService) ListBranches ¶
func (s *GitHubAppService) ListBranches(ctx context.Context, appUUID string, owner, repo string) ([]models.GitHubBranch, error)
ListBranches lists all branches for a repository
func (*GitHubAppService) ListRepositories ¶
func (s *GitHubAppService) ListRepositories(ctx context.Context, appUUID string) ([]models.GitHubRepository, error)
ListRepositories lists all repositories accessible by a GitHub App
func (*GitHubAppService) Update ¶
func (s *GitHubAppService) Update(ctx context.Context, uuid string, req *models.GitHubAppUpdateRequest) error
Update updates an existing GitHub App
type PrivateKeyService ¶
type PrivateKeyService struct {
// contains filtered or unexported fields
}
PrivateKeyService handles private key-related operations
func NewPrivateKeyService ¶
func NewPrivateKeyService(client *api.Client) *PrivateKeyService
NewPrivateKeyService creates a new private key service
func (*PrivateKeyService) Create ¶
func (s *PrivateKeyService) Create(ctx context.Context, req models.PrivateKeyCreateRequest) (*models.PrivateKey, error)
Create creates a new private key
func (*PrivateKeyService) Delete ¶
func (s *PrivateKeyService) Delete(ctx context.Context, uuid string) error
Delete deletes a private key by UUID
func (*PrivateKeyService) List ¶
func (s *PrivateKeyService) List(ctx context.Context) ([]models.PrivateKey, error)
List retrieves all private keys
type ProjectService ¶
type ProjectService struct {
// contains filtered or unexported fields
}
ProjectService handles project-related operations
func NewProjectService ¶
func NewProjectService(client *api.Client) *ProjectService
NewProjectService creates a new project service
type ResourceService ¶
type ResourceService struct {
// contains filtered or unexported fields
}
ResourceService handles resource-related operations
func NewResourceService ¶
func NewResourceService(client *api.Client) *ResourceService
NewResourceService creates a new resource service
type ServerService ¶
type ServerService struct {
// contains filtered or unexported fields
}
ServerService handles server-related operations
func NewServerService ¶
func NewServerService(client *api.Client) *ServerService
NewServerService creates a new server service
func (*ServerService) Create ¶
func (s *ServerService) Create(ctx context.Context, req models.ServerCreateRequest) (*models.Response, error)
Create creates a new server
func (*ServerService) Delete ¶
func (s *ServerService) Delete(ctx context.Context, uuid string) error
Delete deletes a server by UUID
func (*ServerService) GetDomains ¶
GetDomains returns domains for a server
func (*ServerService) GetResources ¶
GetResources returns resources for a server
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service handles service-related operations
func NewService ¶
NewService creates a new service instance
func (*Service) BulkUpdateEnvs ¶
func (s *Service) BulkUpdateEnvs(ctx context.Context, serviceUUID string, req *models.ServiceEnvBulkUpdateRequest) (*models.ServiceEnvBulkUpdateResponse, error)
BulkUpdateEnvs updates multiple environment variables in a single request
func (*Service) Create ¶
func (s *Service) Create(ctx context.Context, req *models.ServiceCreateRequest) (*models.Service, error)
Create creates a new service
func (*Service) CreateEnv ¶
func (s *Service) CreateEnv(ctx context.Context, uuid string, req *models.ServiceEnvironmentVariableCreateRequest) (*models.ServiceEnvironmentVariable, error)
CreateEnv creates a new environment variable for a service
func (*Service) Delete ¶
func (s *Service) Delete(ctx context.Context, uuid string, deleteConfigurations, deleteVolumes, dockerCleanup, deleteConnectedNetworks bool) error
Delete deletes a service
func (*Service) GetEnv ¶
func (s *Service) GetEnv(ctx context.Context, serviceUUID, envIdentifier string) (*models.ServiceEnvironmentVariable, error)
GetEnv retrieves a single environment variable by UUID or key
func (*Service) ListEnvs ¶
func (s *Service) ListEnvs(ctx context.Context, uuid string) ([]models.ServiceEnvironmentVariable, error)
ListEnvs retrieves all environment variables for a service
func (*Service) Restart ¶
func (s *Service) Restart(ctx context.Context, uuid string) (*models.ServiceLifecycleResponse, error)
Restart restarts a service
type TeamService ¶
type TeamService struct {
// contains filtered or unexported fields
}
TeamService handles team-related operations
func NewTeamService ¶
func NewTeamService(client *api.Client) *TeamService
NewTeamService creates a new team service
func (*TeamService) CurrentMembers ¶
func (s *TeamService) CurrentMembers(ctx context.Context) ([]models.TeamMember, error)
CurrentMembers retrieves members of the currently authenticated team
func (*TeamService) ListMembers ¶
func (s *TeamService) ListMembers(ctx context.Context, teamID string) ([]models.TeamMember, error)
ListMembers retrieves members of a specific team