Versions in this module Expand all Collapse all v1 v1.0.1 Oct 7, 2025 Changes in this version + const ExpansionStatusError + const ExpansionStatusPossible + const ExpansionStatusSuccess + const RecoveryStatusCompleted + const RecoveryStatusErrored + const RecoveryStatusOngoing + func ConnectSwarm(urls configuration.URLs, accessToken, tenantID, swarmID string, ...) error + func CreateTenantAccounts(urls configuration.URLs, accessToken, tenantID string, emails []string) error + func DeleteAgent(urls configuration.URLs, accessToken string, swarmID string, nexusID string, ...) error + func DeleteGateway(urls configuration.URLs, accessToken string, tenantID string, gatewayID string) error + func DeleteNexus(urls configuration.URLs, accessToken string, swarmID string, nexusID string) error + func DeleteNode(urls configuration.URLs, accessToken string, swarmID, nexusID, nodeID string) error + func DeleteTenantAccountSessions(urls configuration.URLs, accessToken, tenantID, accountID string) error + func DownloadReport(output string, downloadedFile *string) request_utils.RequestModifier + func DownloadTenantReport(urls configuration.URLs, accessToken, tenantID, from, to, output string) (*string, error) + func EditOperatorRoleInSwarm(urls configuration.URLs, accessToken, swarmID, operatorID string, ...) error + func EditOperatorRoleInTenant(urls configuration.URLs, accessToken, tenantID, operatorID string, ...) error + func EditSwarm(urls configuration.URLs, accessToken string, swarmID string, ...) error + func EditTenant(urls configuration.URLs, accessToken string, tenantID string, ...) error + func EditTenantImage(urls configuration.URLs, accessToken, tenantID, imageURL string) error + func EditTenantSettings(urls configuration.URLs, accessToken string, tenantID string, ...) error + func ExtractGenericModel(response any) request_utils.RequestModifier + func GetDeviceAPIKey(urls configuration.URLs, deviceID string) (string, error) + func InviteOperatorToSwarm(urls configuration.URLs, accessToken, swarmID string, ...) error + func InviteOperatorToTenant(urls configuration.URLs, accessToken, tenantID string, ...) error + func PromoteOperator(urls configuration.URLs, email, policyName, secret string) error + func RemoveSwarm(urls configuration.URLs, accessToken, swarmID string) error + func RemoveSwarmOperator(urls configuration.URLs, accessToken, swarmID, operatorID string) error + func RemoveTenant(urls configuration.URLs, accessToken, tenantID string) error + func RemoveTenantAccount(urls configuration.URLs, accessToken, tenantID, accountID string) error + func RemoveTenantOperator(urls configuration.URLs, accessToken, tenantID, operatorID string) error + func RemoveTenantProject(urls configuration.URLs, accessToken, tenantID, projectID string) error + func RestoreTenantAccount(urls configuration.URLs, accessToken, tenantID, accountID string) error + func RestoreTenantProject(urls configuration.URLs, accessToken, tenantID, projectID string) error + func ToggleBanAccount(urls configuration.URLs, accessToken, tenantID string, accountID string, ...) error + func ToggleBanProject(urls configuration.URLs, accessToken, tenantID string, projectID string, ...) error + func UpdateAccount(urls configuration.URLs, accessToken, tenantID, accountID string, ...) error + func UpdateAgent(urls configuration.URLs, accessToken string, swarmID string, nexusID string, ...) error + func UpdateGateway(urls configuration.URLs, accessToken string, tenantID string, gatewayID string, ...) error + func UpdateNexus(urls configuration.URLs, accessToken string, swarmID string, nexusID string, ...) error + func UpdateNode(urls configuration.URLs, accessToken string, swarmID, nexusID, nodeID string, ...) error + func UpdateProject(urls configuration.URLs, accessToken, tenantID, projectID string, ...) error + func VerifyDNS(urls configuration.URLs, accessToken string, tenantID string) error + type APIKeyResponse struct + APIKey string + Status string + type Account struct + AuthProvider AccountAuthProvider + Banned bool + CreatedAt time.Time + DeletedAt *time.Time + Emails []AccountEmail + EndpointGateway string + FirstName string + ID string + Internal bool + LastName string + MaxAllowedProjects int + TenantID string + TwoFactorEnabled bool + func GetTenantAccount(urls configuration.URLs, accessToken, tenantID, accountID string) (*Account, error) + type AccountAuthProvider string + type AccountEmail struct + CreatedAt time.Time + Default bool + Email string + ID string + Verified bool + type AgentConfig struct + Disk string + ID string + MountPoint string + Port int + Secret string + type AgentModel string + const CellAgentModel + const UnknownAgentModel + const VirtualAgentModel + type AgentVolume struct + Disk string + MountPoint string + type AnsibleConfig struct + Nodes []NodeConfig + type BulkInsertNewAgentRequestBody struct + Agents []CreateNewAgentRequestBody + type BulkInsertNewNodeRequestBody struct + Nodes []CreateNewNodeRequestBody + type ChallengeResponseModel struct + Challenge string + Salt string + type ChangeOperatorPolicyRequestBody struct + PolicyID string + type CreateGatewayRequestBody struct + Configuration map[string]interface{} + Location string + Name string + type CreateNewAgentRequestBody struct + Features map[string]interface{} + Port int + Volume AgentVolume + type CreateNewNodeRequestBody struct + Agents []CreateNewAgentRequestBody + Configuration map[string]interface{} + Label *string + Name string + PrivateIP string + PublicIP string + type CreateNexusRequestBody struct + Description string + Location string + Name string + ProviderID string + type CreateNodeBodyRequest struct + Description string + Name string + NexusID string + SecretID string + type CreateRedundancyClassRequestBody struct + AntiAffinityGroup int + Description string + InnerK int + InnerN int + Name string + Nexuses []string + OuterK int + OuterN int + type CreateSwarmRequest struct + Configuration map[string]interface{} + Description *string + Name string + type CreateTenantRequestBody struct + CouponCode *string + Description *string + Name string + Settings *TenantSettings + ZKEnabled *bool + Zone *string + type DNSChallengeRecord struct + Name string + Type string + Value string + type DeviceRegistrationResponse struct + ClientURL string + DeviceCode string + func RegisterDevice(urls configuration.URLs, uuid string) (*DeviceRegistrationResponse, error) + type Distributor struct + CreatedAt time.Time + DeletedAt time.Time + Description string + ID string + ImageURL string + Name string + OwnerID string + type DistributorCoupon struct + Code string + CreatedAt time.Time + Description string + ExternalID string + ID string + MaxRedemptions int64 + Name string + Redemptions int + Zone string + func (c *DistributorCoupon) ToHumanReadableDistributorCode() *HumanReadableDistributorCoupon + type DistributorCouponCodeResponseModel struct + CouponCode string + type DistributorCouponList struct + Coupons []*DistributorCoupon + type DistributorList struct + Distributors []*Distributor + type DistributorReportResponseModel struct + Report []TenantReport + type EnabledAuthProvidersConfig struct + GoogleClientID *string + MicrosoftApplicationID *string + MicrosoftDirectoryID *string + type ErrorResponseModel struct + Message string + Param string + type EvaluatedStatusType string + type ExpansionStatus string + type Gateway struct + CreatedAt time.Time + DeletedAt *time.Time + ID string + Location string + Name string + OrganizationID *string + Secret string + func GetGateway(urls configuration.URLs, accessToken string, tenantID string, gatewayID string) (*Gateway, error) + type GatewayInstance struct + CreatedAt time.Time + EvaluatedStatus GatewayStatus + Features map[string]interface{} + GatewayID string + ID string + IP string + Status map[string]interface{} + StatusUpdatedAt *time.Time + type GatewayInstanceListResponse struct + Data []*GatewayInstance + type GatewayStatus string + const ActiveGatewayStatus + const InactiveGatewayStatus + const OfflineGatewayStatus + const OnlineGatewayStatus + const UnknownGatewayStatus + type GatewayTenant struct + Configuration map[string]interface{} + CreatedAt time.Time + DeletedAt *time.Time + GatewayID string + HardDeleteAt *time.Time + Hidden bool + ID string + TenantID string + type GatewayWithGatewayTenant struct + Gateway *Gateway + GatewayTenant *GatewayTenant + func CreateGateway(urls configuration.URLs, accessToken string, tenantID string, ...) (*GatewayWithGatewayTenant, error) + type GenericIDResponseModel struct + ID string + func AssignTenantToCoupon(urls configuration.URLs, accessToken, tenantID, CouponCode string) (*GenericIDResponseModel, error) + func CreateProject(urls configuration.URLs, accessToken, name string, description *string, ...) (*GenericIDResponseModel, error) + func CreateSwarm(urls configuration.URLs, accessToken string, req CreateSwarmRequest) (*GenericIDResponseModel, error) + func CreateTenant(urls configuration.URLs, accessToken string, req CreateTenantRequestBody) (*GenericIDResponseModel, error) + type GenericPaginatedResponse struct + Count int + Data []T + NextPage *int + func GetAgent(urls configuration.URLs, accessToken string, ...) (*GenericPaginatedResponse[*NewAgent], error) + func ListAgents(urls configuration.URLs, accessToken string, swarmID string, ...) (*GenericPaginatedResponse[*NewAgent], error) + func ListAgentsForRC(urls configuration.URLs, accessToken string, swarmID string, rcID, sort string, ...) (*GenericPaginatedResponse[*NewAgent], error) + func ListGateways(urls configuration.URLs, accessToken string, tenantID string, sort string, ...) (*GenericPaginatedResponse[*Gateway], error) + func ListNexuses(urls configuration.URLs, accessToken string, swarmID string, sort string, ...) (*GenericPaginatedResponse[*Nexus], error) + func ListNodes(urls configuration.URLs, accessToken string, swarmID string, ...) (*GenericPaginatedResponse[*NewNode], error) + func ListRedundancyClasses(urls configuration.URLs, accessToken, swamID, sort, filter string) (*GenericPaginatedResponse[*RedundancyClass], error) + func ListSwarmsV2(urls configuration.URLs, accessToken string, sort string, filter string) (*GenericPaginatedResponse[*Swarm], error) + func ListTenantAccounts(urls configuration.URLs, accessToken, tenantID, sort, filter string) (*GenericPaginatedResponse[*Account], error) + func ListTenantProjects(urls configuration.URLs, accessToken, tenantID, sort, filter string) (*GenericPaginatedResponse[*ProjectItem], error) + func ListTenants(urls configuration.URLs, accessToken, sort, filter string) (*GenericPaginatedResponse[*Tenant], error) + type GetAgentEvaluatedStatusResponse struct + Status EvaluatedStatusType + func GetAgentStatus(urls configuration.URLs, accessToken, swarmID, nexusID, nodeID, agentID string) (*GetAgentEvaluatedStatusResponse, error) + type HumanReadableDistributorCoupon struct + Code string + CreatedAt time.Time + Description string + ExternalID string + ID string + MaxRedemptions string + Name string + Redemptions int + Zone string + type HumanReadableStatus struct + ChildCount int + ChildErrorCount int + ChildOfflineCount int + ChildOnlineCount int + ChildPendingCount int + ChildType string + ChildWarningCount int + Status string + type InviteOperatorRequestBody struct + Email string + FirstName *string + LastName *string + PolicyID string + type MonitoredResourceForSeverityNotifications map[string]SeverityForNotificationType + type NewAgent struct + AnnouncedPrivateIP *string + AnnouncedPublicIP *string + CRN map[string]interface{} + ConnectedOn *time.Time + CreatedAt time.Time + DeletedAt *time.Time + Features map[string]interface{} + ID string + LastStatusUpdateAt time.Time + Model AgentModel + NodeID string + Online bool + Port int + PublicKey *string + Secret string + Serial *string + TotalStorage int64 + UsedStorage int64 + Version *string + Volume AgentVolume + type NewAgentResponse struct + CRN map[string]interface{} + Features map[string]interface{} + ID string + Port int + Secret string + Volume AgentVolume + type NewAgentsResponse struct + Agents []*NewAgentResponse + func CreateAgent(urls configuration.URLs, accessToken string, swarmID string, nexusID string, ...) (*NewAgentsResponse, error) + type NewNode struct + CRN map[string]interface{} + Configuration map[string]interface{} + CreatedAt time.Time + DeletedAt *time.Time + ID string + Label *string + Name string + NexusID string + PrivateIP string + PublicIP string + func GetNode(urls configuration.URLs, accessToken string, swarmID, nexusID, nodeID string) (*NewNode, error) + type NewNodeResponseItem struct + Agents []NewAgentResponse + CRN map[string]interface{} + Configuration map[string]interface{} + ID string + Label *string + Name string + PrivateIP string + PublicIP string + type NewNodesResponse struct + Nodes []*NewNodeResponseItem + func CreateNodes(urls configuration.URLs, accessToken string, swarmID string, nexusID string, ...) (*NewNodesResponse, error) + type Nexus struct + Capacity int + CreationDate time.Time + Description string + ID string + LastModified time.Time + Location string + Name string + SwarmID string + Used int + func CreateNexus(urls configuration.URLs, accessToken string, swarmID string, ...) (*Nexus, error) + func GetNexus(urls configuration.URLs, accessToken string, swarmID string, nexusID string) (*Nexus, error) + type NexusList struct + Count int + NextPage *int + Nexuses []*Nexus + Page int + type Node struct + Config map[string]interface{} + CreationDate time.Time + Description string + ID string + Name string + NexusID string + ProviderID string + SecretID string + Status string + type NodeConfig struct + Agents []AgentConfig + ID string + Label string + Name string + PrivateIP string + PublicIP string + type NodeList struct + Count int + Nodes []*Node + Page int + type Notification struct + Emails []string + NotifyOwner bool + type Operator struct + Banned bool + CreatedAt time.Time + DeletedAt *time.Time + Email string + Emails []OperatorEmail + FirstName string + ID string + Internal bool + LastName string + MaxAllowedProjects int + PolicyName string + Status string + TwoFactorEnabled bool + func GetOperator(urls configuration.URLs, accessToken, meOrID string) (*Operator, error) + func GetOperatorSelf(urls configuration.URLs, accessToken string) (*Operator, error) + func GetSwarmOperator(urls configuration.URLs, accessToken, swarmID, operatorID string) (*Operator, error) + func GetTenantOperator(urls configuration.URLs, accessToken, tenantID, operatorID string) (*Operator, error) + type OperatorEmail struct + CreatedAt time.Time + Default bool + Email string + ID string + Verified bool + type OperatorList struct + Operators []*Operator + func ListSwarmOperators(urls configuration.URLs, accessToken, swarmID string) (*OperatorList, error) + func ListTenantOperators(urls configuration.URLs, accessToken, tenantID string) (*OperatorList, error) + type Policy struct + AuthorID string + CreatedAt string + ID string + Name string + UpdatedAt string + UserCount int + Version string + type PolicyList struct + Policies []Policy + func ListTenantPolicies(urls configuration.URLs, accessToken, tenantID string) (*PolicyList, error) + type ProjectItem struct + ProjectBannedAt *time.Time + ProjectCreatedAt time.Time + ProjectDeletedAt *time.Time + ProjectDescription string + ProjectEmail string + ProjectID string + ProjectImageURL string + ProjectName string + ProjectTenantID string + RootAccountEmail string + RootAccountID string + func GetTenantProject(urls configuration.URLs, accessToken, tenantID, projectID string) (*ProjectItem, error) + type ProjectReport struct + BandwidthReservedTB string + EgressTB string + ExternalID string + FromTime string + ID string + IngressTB string + ProjectName string + Status string + StorageAVGTB string + StorageBH string + StorageMaxTB string + StorageReservedTB string + StorageTB string + Timestamp time.Duration + ToTime string + type Provider struct + Email string + ID string + Name string + SwarmID string + type ProviderList struct + Count int + Page int + Providers []Provider + type RCProgress struct + ActiveRecoveries []RecoveryProgress + CompletionPercent float64 + FailedRecoveries []RecoveryProgress + Session RCSession + func CheckRedundancyClassRecoveryStatus(urls configuration.URLs, accessToken, swarmID, redundancyClassID string) (*RCProgress, error) + type RCSession struct + Status RCSessionStatus + type RCSessionStatus string + const RCSessionStatusCompleted + const RCSessionStatusFailed + const RCSessionStatusRunning + type RecoveryProgress struct + ProgressPercent float64 + RecoveryID string + type RecoveryStatus string + type RedundancyClass struct + AntiAffinityGroup int + Capacity int + CreationDate time.Time + Description string + ID string + InnerK int + InnerN int + Name string + OuterK int + OuterN int + SwarmID string + func CreateRedundancyClass(urls configuration.URLs, accessToken, swamID string, ...) (*RedundancyClass, error) + func GetRedundancyClass(urls configuration.URLs, accessToken, redundancyClassID string) (*RedundancyClass, error) + type RedundancyClassErrorData struct + IssueFound []interface{} + type RedundancyClassExpanded struct + AgentsInvolved []string + ExpandedSize int64 + Message string + Status ExpansionStatus + func ExpandRedundancyClass(urls configuration.URLs, accessToken, swarmID, redundancyClassID string, ...) (*RedundancyClassExpanded, error) + type RedundancyClassList struct + Data []*RedundancyClass + Page int + type RedundancyClassRecovery struct + Message string + func RecoverRedundancyClass(urls configuration.URLs, accessToken, swarmID, redundancyClassID string, ...) (*RedundancyClassRecovery, error) + type Ring struct + Capacity int + CreationDate string + ID string + K int + N int + Nexuses []RingNexus + Nodes []RingNode + Status string + SwarmID string + Used int + type RingBulk struct + AntiAffinityGroup *int + Nexuses []string + RedundancyClassID string + RingsNumber *int + type RingList struct + Count int + Data []*Ring + Page int + type RingNexus struct + K int + N int + NexusID string + Sequence int + type RingNode struct + NexusID string + NodeID string + Sequence1 int + Sequence2 int + type Severity string + type SeverityForNotificationType map[Severity]SeverityNotificationType + type SeverityNotificationType struct + Notify Notification + Threshold int + type SummaryDetails struct + Error int + Offline int + Online int + Pending int + Warning int + type SummaryDetailsWithStatusNullable struct + Details *SummaryDetails + func CheckRedundancyClassStatus(urls configuration.URLs, accessToken, swarmID, redundancyClassID string) (*SummaryDetailsWithStatusNullable, error) + func GetSwarmStatus(urls configuration.URLs, accessToken, swarmID string) (*SummaryDetailsWithStatusNullable, error) + func (s *SummaryDetailsWithStatusNullable) ToHumanReadableStatus(childEntityType string) HumanReadableStatus + type SummaryStatusNullable struct + EvaluatedStatus *EvaluatedStatusType + EvaluatedStatusLastUpdatedAt *time.Time + type Swarm struct + Configuration map[string]interface{} + CreationDate time.Time + Description *string + ID string + Name string + OrganizationID *string + OwnerID string + Size int64 + Used int64 + func GetSwarm(urls configuration.URLs, accessToken, ownerID string, swarmID string) (*Swarm, error) + func ListSwarms(urls configuration.URLs, accessToken, ownerID string) ([]*Swarm, error) + type SwarmList struct + Swarms []Swarm + func GetTenantCouponSwarms(urls configuration.URLs, accessToken, tenantID string) (*SwarmList, error) + type Tenant struct + CouponID *string + CreatedAt time.Time + DeletedAt *time.Time + Description *string + ID string + Name string + OwnerID string + Settings *TenantSettings + func GetTenant(urls configuration.URLs, accessToken, tenantID string) (*Tenant, error) + type TenantList struct + Tenants []*Tenant + type TenantReport struct + Code string + EngressGB string + ExternalID string + FromTime string + ID string + Status string + StorageBH string + StorageGB string + TenantName string + Timestamp time.Duration + ToTime string + type TenantReportResponseModel struct + Report []ProjectReport + func GetTenantReport(urls configuration.URLs, accessToken, tenantID, from, to string) (*TenantReportResponseModel, error) + type TenantSettings struct + Account *TenantSettingsAccount + AllowedDomains *[]string + BlockedDomains *[]string + ConsoleURL *string + DisplayName *string + GatewayURL *string + Notifications *MonitoredResourceForSeverityNotifications + Project *TenantSettingsProject + SignupDisabled bool + SupportLink *string + WhiteLabel *WhiteLabel + WhitelabelEnabled bool + type TenantSettingsAccount struct + DefaultMaxProject *int + EnabledAuthProviders *[]AccountAuthProvider + EnabledAuthProvidersConfig *EnabledAuthProvidersConfig + type TenantSettingsProject struct + DefaultMaxProjectEgressBandwidth *int64 + DefaultMaxProjectStorage *int64 + type TenantSwarm struct + Default bool + ID string + RedundancyClassID string + RedundancyClassName string + SwarmID string + SwarmName string + TenantID string + type TenantSwarmList struct + Swarms []*TenantSwarm + func ListAvailableTenantSwarms(urls configuration.URLs, accessToken, tenantID string) (*TenantSwarmList, error) + type TokenAndExpirationResponseModel struct + Exp int + ExpDate time.Time + Token string + type URLBuilder struct + func NewURLBuilder(baseURL string) *URLBuilder + func (ub *URLBuilder) Build() string + func (ub *URLBuilder) Path(segments ...string) *URLBuilder + func (ub *URLBuilder) QueryParam(key, value string) *URLBuilder + func (ub *URLBuilder) QueryParamInt(key string, value int) *URLBuilder + type UpdateAccountRequest struct + EndpointGateway *string + FirstName *string + Internal *bool + LastName *string + MaxAllowedProjects *int + type UpdateAgentVolumeRequest struct + Disk *string + MountPoint *string + type UpdateGatewayRequestBody struct + Location *string + Name *string + type UpdateNewAgentRequestBody struct + Features map[string]interface{} + Port *int + Volume *UpdateAgentVolumeRequest + type UpdateNewNodeRequestBody struct + Label *string + Name *string + PrivateIP *string + PublicIP *string + type UpdateNexusRequestBody struct + Description string + Location string + Name string + type UpdateNodeBodyRequest struct + Description string + Name string + type UpdateSwarmRequest struct + Description *string + Name *string + type UpdateTenantProjectRequestBody struct + Description *string + ImageURL *string + Name *string + type UpdateTenantRequestBody struct + Description *string + Settings *TenantSettings + type WhiteLabel struct + DNS *WhiteLabelDNS + EmailDomain *WhiteLabelEmailDomain + type WhiteLabelDNS struct + Challenge string + Value string + Verified bool + type WhiteLabelEmailDomain struct + Challenge []DNSChallengeRecord + User *string + Value string + Verified bool + type ZoneMap struct + Zones map[string]ZoneResponse + func GetGatewayZones(urls configuration.URLs) (*ZoneMap, error) + type ZoneResponse struct + Description string + Key string + Name string
Go to main page