api

package

v0.23.6 Latest Latest Go to latest Published: Mar 29, 2026 License: Apache-2.0 Imports: 36 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 HandleCreateScript(w http.ResponseWriter, r *http.Request)
func HandleCreateSkill(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 HandleDeleteScript(w http.ResponseWriter, r *http.Request)
func HandleDeleteSessions(w http.ResponseWriter, r *http.Request)
func HandleDeleteSkill(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 HandleExecuteScript(w http.ResponseWriter, r *http.Request)
func HandleExecuteScriptStream(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 HandleGetGlobalScripts(w http.ResponseWriter, r *http.Request)
func HandleGetGroup(w http.ResponseWriter, r *http.Request)
func HandleGetGroups(w http.ResponseWriter, r *http.Request)
func HandleGetIcons(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 HandleGetScript(w http.ResponseWriter, r *http.Request)
func HandleGetScriptByName(w http.ResponseWriter, r *http.Request)
func HandleGetScriptDetailsByName(w http.ResponseWriter, r *http.Request)
func HandleGetScripts(w http.ResponseWriter, r *http.Request)
func HandleGetSessions(w http.ResponseWriter, r *http.Request)
func HandleGetSkill(w http.ResponseWriter, r *http.Request)
func HandleGetSkills(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 HandleGetUserHasPermission(w http.ResponseWriter, r *http.Request)
func HandleGetUserPermissions(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 HandleGetVolumeNodes(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 HandleReadSpaceFile(w http.ResponseWriter, r *http.Request)
func HandleRunCommand(w http.ResponseWriter, r *http.Request)
func HandleSSE(w http.ResponseWriter, r *http.Request)
func HandleSearchSkills(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 HandleUpdateScript(w http.ResponseWriter, r *http.Request)
func HandleUpdateSkill(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)
func HandleWriteSpaceFile(w http.ResponseWriter, r *http.Request)
type AvailableNode
type ErrorResponse
type ReadFileRequest
type ReadFileResponse
type RunCommandRequest
type RunCommandResponse
type UnifiedScriptExecuteRequest
type WriteFileRequest
type WriteFileResponse

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 HandleCreateScript ¶ added in v0.23.0

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

func HandleCreateSkill ¶ added in v0.23.0

func HandleCreateSkill(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 HandleDeleteScript ¶ added in v0.23.0

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

func HandleDeleteSessions ¶

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

func HandleDeleteSkill ¶ added in v0.23.0

func HandleDeleteSkill(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 HandleExecuteScript ¶ added in v0.23.0

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

func HandleExecuteScriptStream ¶ added in v0.23.0

func HandleExecuteScriptStream(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 HandleGetGlobalScripts ¶ added in v0.23.0

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

HandleGetGlobalScripts returns global scripts for template editing. Users with PermissionManageTemplates can see global scripts even without PermissionManageScripts.

func HandleGetGroup ¶

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

func HandleGetGroups ¶

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

func HandleGetIcons ¶ added in v0.23.0

func HandleGetIcons(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 HandleGetScript ¶ added in v0.23.0

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

func HandleGetScriptByName ¶ added in v0.23.0

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

func HandleGetScriptDetailsByName ¶ added in v0.23.0

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

func HandleGetScripts ¶ added in v0.23.0

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

func HandleGetSessions ¶

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

func HandleGetSkill ¶ added in v0.23.0

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

func HandleGetSkills ¶ added in v0.23.0

func HandleGetSkills(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 HandleGetUserHasPermission ¶ added in v0.23.0

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

func HandleGetUserPermissions ¶ added in v0.23.0

func HandleGetUserPermissions(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 HandleGetVolumeNodes ¶ added in v0.23.6

func HandleGetVolumeNodes(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 HandleReadSpaceFile ¶ added in v0.23.0

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

func HandleRunCommand ¶ added in v0.23.0

func HandleRunCommand(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 HandleSearchSkills ¶ added in v0.23.0

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

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 HandleUpdateScript ¶ added in v0.23.0

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

func HandleUpdateSkill ¶ added in v0.23.0

func HandleUpdateSkill(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)

func HandleWriteSpaceFile ¶ added in v0.23.0

func HandleWriteSpaceFile(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"`
}

type ReadFileRequest ¶ added in v0.23.0

type ReadFileRequest struct {
	Path string `json:"path"`
}

type ReadFileResponse ¶ added in v0.23.0

type ReadFileResponse struct {
	Success bool   `json:"success"`
	Content string `json:"content,omitempty"`
	Size    int    `json:"size,omitempty"`
	Error   string `json:"error,omitempty"`
}

type RunCommandRequest ¶ added in v0.23.0

type RunCommandRequest struct {
	Command string   `json:"command"`
	Args    []string `json:"args,omitempty"`
	Timeout int      `json:"timeout"`
	Workdir string   `json:"workdir,omitempty"`
}

type RunCommandResponse ¶ added in v0.23.0

type RunCommandResponse struct {
	Success bool   `json:"success"`
	Output  string `json:"output,omitempty"`
	Error   string `json:"error,omitempty"`
}

type UnifiedScriptExecuteRequest ¶ added in v0.23.0

type UnifiedScriptExecuteRequest struct {
	ScriptId   string   `json:"script_id,omitempty"`
	ScriptName string   `json:"script_name,omitempty"`
	Content    string   `json:"content,omitempty"`
	Arguments  []string `json:"arguments"`
}

type WriteFileRequest ¶ added in v0.23.0

type WriteFileRequest struct {
	Path    string `json:"path"`
	Content string `json:"content"`
}

type WriteFileResponse ¶ added in v0.23.0

type WriteFileResponse struct {
	Success      bool   `json:"success"`
	BytesWritten int    `json:"bytes_written,omitempty"`
	Error        string `json:"error,omitempty"`
}

Directories ¶

Path	Synopsis
api_utils

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