apiclient

package

Go to main page

Versions in this module

v0

v0.15.2

Feb 8, 2025

v0.15.1

Feb 4, 2025

v0.15.0

Feb 3, 2025

Changes in this version

type ApiClient

+ func (c *ApiClient) UsingTOTP() (bool, int, error)

type AuthLoginRequest

+ TOTPCode string

type AuthLoginResponse

+ TOTPSecret string

type TemplateCreateRequest

+ Locations []string

type TemplateDetails

+ Locations []string

type TemplateInfo

+ Locations []string

type TemplateUpdateRequest

+ Locations []string

type UserResponse

+ TOTPSecret string

+ type UsingTOTPResponse struct

+ UsingTOTP bool

v0.14.8

Jan 31, 2025

v0.14.7

Jan 30, 2025

v0.14.6

Jan 29, 2025

v0.14.5

Jan 28, 2025

v0.14.4

Jan 25, 2025

v0.14.3

Jan 21, 2025

v0.14.2

Jan 21, 2025

v0.14.1

Jan 19, 2025

v0.14.0

Jan 19, 2025

v0.12.10

Jan 16, 2025

v0.12.9

Jan 15, 2025

Changes in this version

type ApiClient

+ func (c *ApiClient) GetAuditLogs(start int, maxItems int) (*AuditLogs, int, error)

+ type AuditLogEntry struct

+ Actor string

+ ActorType string

+ Details string

+ Event string

+ Id int64

+ Properties map[string]interface{}

+ When time.Time

+ type AuditLogs struct

+ Count int

+ Items []AuditLogEntry

v0.12.7

Jan 12, 2025

Changes in this version

type ApiClient

+ func (c *ApiClient) GetTunnelDomain() (string, int, error)

+ func (c *ApiClient) GetTunnels() ([]TunnelInfo, int, error)

+ type TunnelInfo struct

+ Address string

+ Name string

v0.12.6

Jan 10, 2025

Changes in this version

type SpaceServiceState

+ HasState bool

v0.12.5

Jan 9, 2025

v0.12.4

Jan 6, 2025

v0.12.3

Jan 4, 2025

Changes in this version

type GroupInfo

+ MaxTunnels uint32

type UserGroupRequest

+ MaxTunnels uint32

type UserInfo

+ MaxTunnels uint32

type UserQuota

+ MaxTunnels uint32

+ UsedTunnels uint32

type UserResponse

+ MaxTunnels uint32

v0.12.2

Jan 4, 2025

v0.12.1

Dec 30, 2024

v0.12.0

Dec 29, 2024

Changes in this version

type ApiClient

+ func (c *ApiClient) CreateRole(roleName string, permissions []uint16) (string, int, error)

+ func (c *ApiClient) DeleteRole(roleId string) (int, error)

+ func (c *ApiClient) GetPermissions() (*PermissionInfoList, int, error)

+ func (c *ApiClient) GetRole(roleId string) (*RoleDetails, int, error)

+ func (c *ApiClient) GetRoles() (*RoleInfoList, int, error)

+ func (c *ApiClient) GetUserQuota(userId string) (*UserQuota, error)

+ func (c *ApiClient) UpdateRole(roleId string, roleName string, permissions []uint16) (int, error)

type GroupInfo

+ ComputeUnits uint32

+ MaxSpaces uint32

+ StorageUnits uint32

+ type PermissionInfo struct

+ Id int

+ Name string

+ type PermissionInfoList struct

+ Count int

+ Permissions []PermissionInfo

+ type RoleDetails struct

+ Id string

+ Name string

+ Permissions []uint16

+ type RoleInfo struct

+ Id string

+ Name string

+ type RoleInfoList struct

+ Count int

+ Roles []RoleInfo

+ type RoleResponse struct

+ Id string

+ Status bool

type TemplateCreateRequest

+ ComputeUnits uint32

+ Schedule []TemplateDetailsDay

+ ScheduleEnabled bool

+ StorageUnits uint32

type TemplateDetails

+ ComputeUnits uint32

+ Schedule []TemplateDetailsDay

+ ScheduleEnabled bool

+ StorageUnits uint32

+ type TemplateDetailsDay struct

+ Enabled bool

+ From string

+ To string

type TemplateInfo

+ ComputeUnits uint32

+ Schedule []TemplateDetailsDay

+ ScheduleEnabled bool

+ StorageUnits uint32

type TemplateUpdateRequest

+ ComputeUnits uint32

+ Schedule []TemplateDetailsDay

+ ScheduleEnabled bool

+ StorageUnits uint32

type UserGroupRequest

+ ComputeUnits uint32

+ MaxSpaces uint32

+ StorageUnits uint32

type UserInfo

+ ComputeUnits uint32

+ StorageUnits uint32

+ UsedComputeUnits uint32

+ UsedStorageUnits uint32

+ type UserQuota struct

+ ComputeUnits uint32

+ MaxSpaces uint32

+ NumberSpaces int

+ NumberSpacesDeployed int

+ StorageUnits uint32

+ UsedComputeUnits uint32

+ UsedStorageUnits uint32

type UserResponse

+ ComputeUnits uint32

+ StorageUnits uint32

+ type UserRoleRequest struct

+ Name string

+ Permissions []uint16

v0.11.6

Dec 15, 2024

v0.11.5

Dec 13, 2024

Changes in this version

type SpaceInfo

+ IsManual bool

type TemplateCreateRequest

+ IsManual bool

+ WithCodeServer bool

+ WithSSH bool

+ WithTerminal bool

+ WithVSCodeTunnel bool

type TemplateDetails

+ IsManual bool

+ WithCodeServer bool

+ WithSSH bool

+ WithTerminal bool

+ WithVSCodeTunnel bool

type TemplateInfo

+ IsManual bool

type TemplateUpdateRequest

+ WithCodeServer bool

+ WithSSH bool

+ WithTerminal bool

+ WithVSCodeTunnel bool

v0.11.1

Dec 2, 2024

v0.11.0

Dec 2, 2024

Changes in this version

type SpaceInfo

+ LocalContainer bool

+ type TemplateCreateRequest struct

+ Description string

+ Groups []string

+ Job string

+ LocalContainer bool

+ Name string

+ Volumes string

type TemplateDetails

+ LocalContainer bool

type TemplateInfo

+ LocalContainer bool

+ type TemplateUpdateRequest struct

+ Description string

+ Groups []string

+ Job string

+ Name string

+ Volumes string

+ type VolumeCreateRequest struct

+ Definition string

+ LocalContainer bool

+ Name string

type VolumeDefinition

+ LocalContainer bool

type VolumeInfo

+ LocalContainer bool

+ type VolumeUpdateRequest struct

+ Definition string

+ Name string

v0.10.1

Nov 30, 2024

v0.10.0

Nov 28, 2024

Changes in this version

type ApiClient

+ func (c *ApiClient) LoginUserToken(userId string, token string) error

type SpaceServiceState

+ HasVSCodeTunnel bool

+ VSCodeTunnel string

type TemplateVar

+ Local bool

+ Restricted bool

type TemplateVarValue

+ Local bool

+ Restricted bool

v0.9.6

Oct 25, 2024

v0.9.5

Oct 20, 2024

v0.9.4

Oct 19, 2024

v0.9.3

Oct 19, 2024

v0.9.2

Jun 9, 2024

v0.9.1

May 16, 2024

v0.9.0

May 13, 2024

Changes in this version

+ const AuthRemoteServerToken

+ const AuthSessionCookie

+ const AuthToken

+ type ApiClient struct

+ func NewClient(baseURL string, token string, insecureSkipVerify bool) *ApiClient

+ func NewRemoteServerClient(baseURL string) *ApiClient

+ func NewRemoteSession(token string) *ApiClient

+ func NewRemoteToken(token string) *ApiClient

+ func (c *ApiClient) AppendUserAgent(userAgent string) *ApiClient

+ func (c *ApiClient) CreateGroup(groupName string) (string, int, error)

+ func (c *ApiClient) CreateSpace(space *model.Space) (int, error)

+ func (c *ApiClient) CreateTemplate(name string, job string, description string, volumes string, groups []string) (string, int, error)

+ func (c *ApiClient) CreateTemplateVar(name string, location string, value string, protected bool) (string, int, error)

+ func (c *ApiClient) CreateToken(name string) (string, int, error)

+ func (c *ApiClient) CreateUser(request *CreateUserRequest) (string, int, error)

+ func (c *ApiClient) CreateVolume(name string, definition string) (*VolumeCreateResponse, int, error)

+ func (c *ApiClient) DeleteGroup(groupId string) (int, error)

+ func (c *ApiClient) DeleteSpace(spaceId string) (int, error)

+ func (c *ApiClient) DeleteTemplate(templateId string) (int, error)

+ func (c *ApiClient) DeleteTemplateVar(templateVarId string) (int, error)

+ func (c *ApiClient) DeleteToken(tokenId string) (int, error)

+ func (c *ApiClient) DeleteUser(userId string) error

+ func (c *ApiClient) DeleteVolume(volumeId string) (int, error)

+ func (c *ApiClient) GetGroup(groupId string) (*GroupInfo, int, error)

+ func (c *ApiClient) GetGroups() (*GroupInfoList, int, error)

+ func (c *ApiClient) GetSpace(spaceId string) (*model.Space, int, error)

+ func (c *ApiClient) GetSpaceServiceState(spaceId string) (*SpaceServiceState, int, error)

+ func (c *ApiClient) GetSpaces(userId string) (*SpaceInfoList, int, error)

+ func (c *ApiClient) GetTemplate(templateId string) (*TemplateDetails, int, error)

+ func (c *ApiClient) GetTemplateObject(templateId string) (*model.Template, int, error)

+ func (c *ApiClient) GetTemplateVar(templateVarId string) (*TemplateVarValue, int, error)

+ func (c *ApiClient) GetTemplateVarValues() ([]*model.TemplateVar, int, error)

+ func (c *ApiClient) GetTemplateVars() (*TemplateVarList, int, error)

+ func (c *ApiClient) GetTemplates() (*TemplateList, int, error)

+ func (c *ApiClient) GetTokens() (*[]TokenInfo, int, error)

+ func (c *ApiClient) GetUser(userId string) (*model.User, error)

+ func (c *ApiClient) GetUsers(state string, location string) (*UserInfoList, error)

+ func (c *ApiClient) GetVolume(volumeId string) (*VolumeDefinition, int, error)

+ func (c *ApiClient) GetVolumeObject(volumeId string) (*model.Volume, int, error)

+ func (c *ApiClient) GetVolumes() (*VolumeInfoList, int, error)

+ func (c *ApiClient) Login(email string, password string) (string, int, error)

+ func (c *ApiClient) Logout() error

+ func (c *ApiClient) NotifyRemoteUserDelete(userId string) error

+ func (c *ApiClient) NotifyRemoteUserUpdate(userId string) error

+ func (c *ApiClient) Ping() (string, error)

+ func (c *ApiClient) RegisterRemoteServer(url string) (string, string, error)

+ func (c *ApiClient) RemoteCreateUserSession(userId string) (string, int, error)

+ func (c *ApiClient) RemoteDeleteSpace(spaceId string) (int, error)

+ func (c *ApiClient) RemoteFetchTemplateHashes() (*map[string]string, error)

+ func (c *ApiClient) RemoteGetSpace(spaceId string) (*model.Space, int, error)

+ func (c *ApiClient) RemoteGetUser(userId string) (*model.User, error)

+ func (c *ApiClient) RemoteUpdateSpace(space *model.Space) (int, error)

+ func (c *ApiClient) RemoteUpdateVolume(volume *model.Volume) (int, error)

+ func (c *ApiClient) SetAuthToken(token string) *ApiClient

+ func (c *ApiClient) SetBaseUrl(baseURL string) *ApiClient

+ func (c *ApiClient) StartSpace(spaceId string) (int, error)

+ func (c *ApiClient) StartVolume(volumeId string) (*StartVolumeResponse, int, error)

+ func (c *ApiClient) StopSpace(spaceId string) (int, error)

+ func (c *ApiClient) StopVolume(volumeId string) (int, error)

+ func (c *ApiClient) UpdateGroup(groupId string, groupName string) (int, error)

+ func (c *ApiClient) UpdateRemoteServer(serverId string) error

+ func (c *ApiClient) UpdateSpace(space *model.Space) (int, error)

+ func (c *ApiClient) UpdateTemplate(templateId string, name string, job string, description string, volumes string, ...) (int, error)

+ func (c *ApiClient) UpdateTemplateVar(templateVarId string, name string, location string, value string, ...) (int, error)

+ func (c *ApiClient) UpdateUser(user *model.User) error

+ func (c *ApiClient) UpdateVolume(volumeId string, name string, definition string) (int, error)

+ func (c *ApiClient) UseSessionCookie(useCookie bool) *ApiClient

+ func (c *ApiClient) WhoAmI() (*model.User, error)

+ type AuthLoginRequest struct

+ Email string

+ Password string

+ type AuthLoginResponse struct

+ Status bool

+ Token string

+ type AuthLogoutResponse struct

+ Status bool

+ type CreateRemoteSessionResponse struct

+ SessionId string

+ Status bool

+ type CreateSpaceRequest = SpaceRequest

+ type CreateSpaceResponse struct

+ SpaceID string

+ Status bool

+ type CreateTokenRequest struct

+ Name string

+ type CreateTokenResponse struct

+ Status bool

+ TokenID string

+ type CreateUserRequest = userRequest

+ type CreateUserResponse struct

+ Status bool

+ UserId string

+ type CreateVolumeRequest = VolumeRequest

+ type GroupInfo struct

+ Id string

+ Name string

+ type GroupInfoList struct

+ Count int

+ Groups []GroupInfo

+ type GroupResponse struct

+ Id string

+ Status bool

+ type PingResponse struct

+ Status bool

+ Version string

+ type RegisterRemoteServerRequest struct

+ Url string

+ type RegisterRemoteServerResponse struct

+ ServerId string

+ Status bool

+ Version string

+ type SpaceDefinition struct

+ AgentURL string

+ AltNames []string

+ IsDeleting bool

+ IsDeployed bool

+ IsPending bool

+ Location string

+ Name string

+ Shell string

+ TemplateId string

+ UserId string

+ VolumeData map[string]model.SpaceVolume

+ VolumeSizes map[string]int64

+ type SpaceInfo struct

+ Id string

+ Location string

+ Name string

+ TemplateId string

+ TemplateName string

+ UserId string

+ Username string

+ VolumeSize int

+ type SpaceInfoList struct

+ Count int

+ Spaces []SpaceInfo

+ type SpaceRequest struct

+ AgentURL string

+ AltNames []string

+ Location string

+ Name string

+ Shell string

+ TemplateId string

+ UserId string

+ VolumeSizes map[string]int64

+ type SpaceServiceState struct

+ HasCodeServer bool

+ HasHttpVNC bool

+ HasSSH bool

+ HasTerminal bool

+ HttpPorts []int

+ IsDeleting bool

+ IsDeployed bool

+ IsPending bool

+ IsRemote bool

+ Location string

+ Name string

+ TcpPorts []int

+ UpdateAvailable bool

+ type StartVolumeResponse struct

+ Location string

+ Status bool

+ type TemplateCreateResponse struct

+ Id string

+ Status bool

+ type TemplateDetails struct

+ Deployed int

+ Description string

+ Groups []string

+ Hash string

+ Job string

+ Name string

+ Usage int

+ VolumeSizes []map[string]interface{}

+ Volumes string

+ type TemplateInfo struct

+ Deployed int

+ Description string

+ Groups []string

+ Id string

+ Name string

+ Usage int

+ type TemplateList struct

+ Count int

+ Templates []TemplateInfo

+ type TemplateRequest struct

+ Description string

+ Groups []string

+ Job string

+ Name string

+ Volumes string

+ type TemplateVar struct

+ Id string

+ Location string

+ Name string

+ Protected bool

+ type TemplateVarCreateResponse struct

+ Id string

+ Status bool

+ type TemplateVarList struct

+ Count int

+ TemplateVar []TemplateVar

+ type TemplateVarValue struct

+ Location string

+ Name string

+ Protected bool

+ Value string

+ type TemplateVarValues struct

+ Id string

+ Name string

+ Protected bool

+ Value string

+ type TokenInfo struct

+ ExpiresAfter time.Time

+ Id string

+ Name string

+ type UpdateSpaceRequest = SpaceRequest

+ type UpdateUserRequest = userRequest

+ type UpdateVolumeRequest = VolumeRequest

+ type UserGroupRequest struct

+ Name string

+ type UserInfo struct

+ Active bool

+ Current bool

+ Email string

+ Groups []string

+ Id string

+ LastLoginAt *time.Time

+ MaxDiskSpace int

+ MaxSpaces int

+ NumberSpaces int

+ NumberSpacesDeployed int

+ NumberSpacesDeployedInLocation int

+ Roles []string

+ UsedDiskSpace int

+ Username string

+ type UserInfoList struct

+ Count int

+ Users []UserInfo

+ type UserResponse struct

+ Active bool

+ CreatedAt time.Time

+ Current bool

+ Email string

+ GitHubUsername string

+ Groups []string

+ Id string

+ LastLoginAt *time.Time

+ MaxDiskSpace int

+ MaxSpaces int

+ PreferredShell string

+ Roles []string

+ SSHPublicKey string

+ ServicePassword string

+ Timezone string

+ UpdatedAt time.Time

+ Username string

+ type VolumeCreateResponse struct

+ Status bool

+ VolumeId string

+ type VolumeDefinition struct

+ Active bool

+ Definition string

+ Location string

+ Name string

+ type VolumeInfo struct

+ Active bool

+ Id string

+ Location string

+ Name string

+ type VolumeInfoList struct

+ Count int

+ Volumes []VolumeInfo

+ type VolumeRequest struct

+ Definition string

+ Name string

+ type VolumeStartRequest = VolumeStartStopRequest

+ type VolumeStartResponse = VolumeStartStopResponse

+ type VolumeStartStopRequest struct

+ Location string

+ type VolumeStartStopResponse struct

+ Definition string

+ Location string

+ Name string

+ Variables map[string]interface{}

+ type VolumeStopRequest = VolumeStartStopRequest

+ type VolumeStopResponse = VolumeStartStopResponse

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL