api

package

v0.22.3 Latest Latest Go to latest Published: Jan 8, 2026 License: Apache-2.0 Imports: 33 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/paularlott/knot

Links

Open Source Insights

Documentation ¶

Index ¶

func ApiRoutes(router *http.ServeMux)
func HandleAuthorization(w http.ResponseWriter, r *http.Request)
func HandleCreateGroup(w http.ResponseWriter, r *http.Request)
func HandleCreateRole(w http.ResponseWriter, r *http.Request)
func HandleCreateSpace(w http.ResponseWriter, r *http.Request)
func HandleCreateTemplate(w http.ResponseWriter, r *http.Request)
func HandleCreateTemplateVar(w http.ResponseWriter, r *http.Request)
func HandleCreateToken(w http.ResponseWriter, r *http.Request)
func HandleCreateUser(w http.ResponseWriter, r *http.Request)
func HandleCreateVolume(w http.ResponseWriter, r *http.Request)
func HandleDeleteGroup(w http.ResponseWriter, r *http.Request)
func HandleDeleteRole(w http.ResponseWriter, r *http.Request)
func HandleDeleteSessions(w http.ResponseWriter, r *http.Request)
func HandleDeleteSpace(w http.ResponseWriter, r *http.Request)
func HandleDeleteTemplate(w http.ResponseWriter, r *http.Request)
func HandleDeleteTemplateVar(w http.ResponseWriter, r *http.Request)
func HandleDeleteToken(w http.ResponseWriter, r *http.Request)
func HandleDeleteTunnel(w http.ResponseWriter, r *http.Request)
func HandleDeleteUser(w http.ResponseWriter, r *http.Request)
func HandleDeleteVolume(w http.ResponseWriter, r *http.Request)
func HandleGetAuditLogs(w http.ResponseWriter, r *http.Request)
func HandleGetClusterInfo(w http.ResponseWriter, r *http.Request)
func HandleGetClusterNode(w http.ResponseWriter, r *http.Request)
func HandleGetGroup(w http.ResponseWriter, r *http.Request)
func HandleGetGroups(w http.ResponseWriter, r *http.Request)
func HandleGetPermissions(w http.ResponseWriter, r *http.Request)
func HandleGetRole(w http.ResponseWriter, r *http.Request)
func HandleGetRoles(w http.ResponseWriter, r *http.Request)
func HandleGetSessions(w http.ResponseWriter, r *http.Request)
func HandleGetSpace(w http.ResponseWriter, r *http.Request)
func HandleGetSpaceCustomField(w http.ResponseWriter, r *http.Request)
func HandleGetSpaces(w http.ResponseWriter, r *http.Request)
func HandleGetTemplate(w http.ResponseWriter, r *http.Request)
func HandleGetTemplateNodes(w http.ResponseWriter, r *http.Request)
func HandleGetTemplateVar(w http.ResponseWriter, r *http.Request)
func HandleGetTemplateVars(w http.ResponseWriter, r *http.Request)
func HandleGetTemplates(w http.ResponseWriter, r *http.Request)
func HandleGetTokens(w http.ResponseWriter, r *http.Request)
func HandleGetTunnelServerInfo(w http.ResponseWriter, r *http.Request)
func HandleGetTunnels(w http.ResponseWriter, r *http.Request)
func HandleGetUser(w http.ResponseWriter, r *http.Request)
func HandleGetUserQuota(w http.ResponseWriter, r *http.Request)
func HandleGetUsers(w http.ResponseWriter, r *http.Request)
func HandleGetVolume(w http.ResponseWriter, r *http.Request)
func HandleGetVolumes(w http.ResponseWriter, r *http.Request)
func HandleLogout(w http.ResponseWriter, r *http.Request)
func HandlePing(w http.ResponseWriter, r *http.Request)
func HandleSSE(w http.ResponseWriter, r *http.Request)
func HandleSetSpaceCustomField(w http.ResponseWriter, r *http.Request)
func HandleSpaceAddShare(w http.ResponseWriter, r *http.Request)
func HandleSpaceRemoveShare(w http.ResponseWriter, r *http.Request)
func HandleSpaceRestart(w http.ResponseWriter, r *http.Request)
func HandleSpaceStart(w http.ResponseWriter, r *http.Request)
func HandleSpaceStop(w http.ResponseWriter, r *http.Request)
func HandleSpaceStopUsersSpaces(w http.ResponseWriter, r *http.Request)
func HandleSpaceTransfer(w http.ResponseWriter, r *http.Request)
func HandleUpdateGroup(w http.ResponseWriter, r *http.Request)
func HandleUpdateRole(w http.ResponseWriter, r *http.Request)
func HandleUpdateSpace(w http.ResponseWriter, r *http.Request)
func HandleUpdateTemplate(w http.ResponseWriter, r *http.Request)
func HandleUpdateTemplateVar(w http.ResponseWriter, r *http.Request)
func HandleUpdateUser(w http.ResponseWriter, r *http.Request)
func HandleUpdateVolume(w http.ResponseWriter, r *http.Request)
func HandleUsingTotp(w http.ResponseWriter, r *http.Request)
func HandleVolumeStart(w http.ResponseWriter, r *http.Request)
func HandleVolumeStop(w http.ResponseWriter, r *http.Request)
func HandleWhoAmI(w http.ResponseWriter, r *http.Request)
type AvailableNode
type ErrorResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ApiRoutes ¶

func ApiRoutes(router *http.ServeMux)

func HandleAuthorization ¶

func HandleAuthorization(w http.ResponseWriter, r *http.Request)

func HandleCreateGroup ¶

func HandleCreateGroup(w http.ResponseWriter, r *http.Request)

func HandleCreateRole ¶

func HandleCreateRole(w http.ResponseWriter, r *http.Request)

func HandleCreateSpace ¶

func HandleCreateSpace(w http.ResponseWriter, r *http.Request)

func HandleCreateTemplate ¶

func HandleCreateTemplate(w http.ResponseWriter, r *http.Request)

func HandleCreateTemplateVar ¶

func HandleCreateTemplateVar(w http.ResponseWriter, r *http.Request)

func HandleCreateToken ¶

func HandleCreateToken(w http.ResponseWriter, r *http.Request)

func HandleCreateUser ¶

func HandleCreateUser(w http.ResponseWriter, r *http.Request)

func HandleCreateVolume ¶

func HandleCreateVolume(w http.ResponseWriter, r *http.Request)

func HandleDeleteGroup ¶

func HandleDeleteGroup(w http.ResponseWriter, r *http.Request)

func HandleDeleteRole ¶

func HandleDeleteRole(w http.ResponseWriter, r *http.Request)

func HandleDeleteSessions ¶

func HandleDeleteSessions(w http.ResponseWriter, r *http.Request)

func HandleDeleteSpace ¶

func HandleDeleteSpace(w http.ResponseWriter, r *http.Request)

func HandleDeleteTemplate ¶

func HandleDeleteTemplate(w http.ResponseWriter, r *http.Request)

func HandleDeleteTemplateVar ¶

func HandleDeleteTemplateVar(w http.ResponseWriter, r *http.Request)

func HandleDeleteToken ¶

func HandleDeleteToken(w http.ResponseWriter, r *http.Request)

func HandleDeleteTunnel ¶

func HandleDeleteTunnel(w http.ResponseWriter, r *http.Request)

func HandleDeleteUser ¶

func HandleDeleteUser(w http.ResponseWriter, r *http.Request)

func HandleDeleteVolume ¶

func HandleDeleteVolume(w http.ResponseWriter, r *http.Request)

func HandleGetAuditLogs ¶

func HandleGetAuditLogs(w http.ResponseWriter, r *http.Request)

func HandleGetClusterInfo ¶

func HandleGetClusterInfo(w http.ResponseWriter, r *http.Request)

func HandleGetClusterNode ¶ added in v0.22.0

func HandleGetClusterNode(w http.ResponseWriter, r *http.Request)

func HandleGetGroup ¶

func HandleGetGroup(w http.ResponseWriter, r *http.Request)

func HandleGetGroups ¶

func HandleGetGroups(w http.ResponseWriter, r *http.Request)

func HandleGetPermissions ¶

func HandleGetPermissions(w http.ResponseWriter, r *http.Request)

func HandleGetRole ¶

func HandleGetRole(w http.ResponseWriter, r *http.Request)

func HandleGetRoles ¶

func HandleGetRoles(w http.ResponseWriter, r *http.Request)

func HandleGetSessions ¶

func HandleGetSessions(w http.ResponseWriter, r *http.Request)

func HandleGetSpace ¶

func HandleGetSpace(w http.ResponseWriter, r *http.Request)

func HandleGetSpaceCustomField ¶ added in v0.21.5

func HandleGetSpaceCustomField(w http.ResponseWriter, r *http.Request)

func HandleGetSpaces ¶

func HandleGetSpaces(w http.ResponseWriter, r *http.Request)

func HandleGetTemplate ¶

func HandleGetTemplate(w http.ResponseWriter, r *http.Request)

func HandleGetTemplateNodes ¶ added in v0.22.0

func HandleGetTemplateNodes(w http.ResponseWriter, r *http.Request)

func HandleGetTemplateVar ¶

func HandleGetTemplateVar(w http.ResponseWriter, r *http.Request)

func HandleGetTemplateVars ¶

func HandleGetTemplateVars(w http.ResponseWriter, r *http.Request)

func HandleGetTemplates ¶

func HandleGetTemplates(w http.ResponseWriter, r *http.Request)

func HandleGetTokens ¶

func HandleGetTokens(w http.ResponseWriter, r *http.Request)

func HandleGetTunnelServerInfo ¶

func HandleGetTunnelServerInfo(w http.ResponseWriter, r *http.Request)

func HandleGetTunnels ¶

func HandleGetTunnels(w http.ResponseWriter, r *http.Request)

func HandleGetUser ¶

func HandleGetUser(w http.ResponseWriter, r *http.Request)

func HandleGetUserQuota ¶

func HandleGetUserQuota(w http.ResponseWriter, r *http.Request)

func HandleGetUsers ¶

func HandleGetUsers(w http.ResponseWriter, r *http.Request)

func HandleGetVolume ¶

func HandleGetVolume(w http.ResponseWriter, r *http.Request)

func HandleGetVolumes ¶

func HandleGetVolumes(w http.ResponseWriter, r *http.Request)

func HandleLogout ¶

func HandleLogout(w http.ResponseWriter, r *http.Request)

func HandlePing ¶

func HandlePing(w http.ResponseWriter, r *http.Request)

func HandleSSE ¶ added in v0.21.8

func HandleSSE(w http.ResponseWriter, r *http.Request)

HandleSSE handles Server-Sent Events connections for real-time updates

func HandleSetSpaceCustomField ¶ added in v0.21.5

func HandleSetSpaceCustomField(w http.ResponseWriter, r *http.Request)

func HandleSpaceAddShare ¶

func HandleSpaceAddShare(w http.ResponseWriter, r *http.Request)

func HandleSpaceRemoveShare ¶

func HandleSpaceRemoveShare(w http.ResponseWriter, r *http.Request)

func HandleSpaceRestart ¶

func HandleSpaceRestart(w http.ResponseWriter, r *http.Request)

func HandleSpaceStart ¶

func HandleSpaceStart(w http.ResponseWriter, r *http.Request)

func HandleSpaceStop ¶

func HandleSpaceStop(w http.ResponseWriter, r *http.Request)

func HandleSpaceStopUsersSpaces ¶

func HandleSpaceStopUsersSpaces(w http.ResponseWriter, r *http.Request)

func HandleSpaceTransfer ¶

func HandleSpaceTransfer(w http.ResponseWriter, r *http.Request)

func HandleUpdateGroup ¶

func HandleUpdateGroup(w http.ResponseWriter, r *http.Request)

func HandleUpdateRole ¶

func HandleUpdateRole(w http.ResponseWriter, r *http.Request)

func HandleUpdateSpace ¶

func HandleUpdateSpace(w http.ResponseWriter, r *http.Request)

func HandleUpdateTemplate ¶

func HandleUpdateTemplate(w http.ResponseWriter, r *http.Request)

func HandleUpdateTemplateVar ¶

func HandleUpdateTemplateVar(w http.ResponseWriter, r *http.Request)

func HandleUpdateUser ¶

func HandleUpdateUser(w http.ResponseWriter, r *http.Request)

func HandleUpdateVolume ¶

func HandleUpdateVolume(w http.ResponseWriter, r *http.Request)

func HandleUsingTotp ¶

func HandleUsingTotp(w http.ResponseWriter, r *http.Request)

Returns if the server is using TOTP or not, the CLI client uses this to work out the authentication flow it should use.

func HandleVolumeStart ¶

func HandleVolumeStart(w http.ResponseWriter, r *http.Request)

func HandleVolumeStop ¶

func HandleVolumeStop(w http.ResponseWriter, r *http.Request)

func HandleWhoAmI ¶

func HandleWhoAmI(w http.ResponseWriter, r *http.Request)

Types ¶

type AvailableNode ¶ added in v0.22.0

type AvailableNode struct {
	NodeId        string `json:"node_id"`
	Hostname      string `json:"hostname"`
	RunningSpaces int    `json:"running_spaces"`
	TotalSpaces   int    `json:"total_spaces"`
}

type ErrorResponse ¶

type ErrorResponse struct {
	Error string `json:"error"`
}

Directories ¶

Path	Synopsis
api_utils

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