api

Oct 20, 2026

Changes in this version

+ type BindingRequest struct

+ Kind string

+ Role string

+ Selector db.Selector

+ Subject string

type CreateAPIKeyRequest

+ Role string

+ Selector db.Selector

type CreateAPIKeyResponse

+ Role string

+ Selector db.Selector

type CreateTargetRequest

+ Labels db.Labels

type CreateTokenRequest

+ Labels db.Labels

type CreateTokenResponse

+ Labels db.Labels

type KeyRingRequest

+ Labels db.Labels

type MeResponse

+ Bindings []auth.Binding

+ Permissions []string

+ type RoleRequest struct

+ Description string

+ Name string

+ Permissions []string

type ServerAPI

+ RBAC *auth.Resolver

+ Sessions *auth.SessionChecker

+ Version string

+ func (s *ServerAPI) HandleCheckTargetToken(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleCreateBinding(w http.ResponseWriter, r *http.Request)

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

+ func (s *ServerAPI) HandleDeleteBinding(w http.ResponseWriter, r *http.Request)

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

+ func (s *ServerAPI) HandleListAudit(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListBindings(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListPermissions(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListRoles(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListSeenSubjects(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListSessions(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleParseSelector(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRevokeSession(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRevokeUserSessions(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleSetAgentLabels(w http.ResponseWriter, r *http.Request)

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

+ type SetLabelsRequest struct

+ Labels db.Labels

Oct 16, 2026

Changes in this version

type AgentUpdate

+ Archive string

+ ArchiveURL string

+ BundleURL string

+ ChecksumsURL string

type CreateTargetRequest

+ KeyRingID string

+ type KeyRingRequest struct

+ MasterPublicKey *string

+ Name string

+ type KeyRingResponse struct

+ Keys []*db.TargetKey

type ServerAPI

+ func (s *ServerAPI) HandleAgentUpdateArchive(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleAgentUpdateBundle(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleAgentUpdateChecksums(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleCreateKeyRing(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleDeleteKeyRing(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleExportKeyRingKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetKeyRing(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleImportKeyRingKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListKeyRings(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRotateKeyRing(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleUpdateKeyRing(w http.ResponseWriter, r *http.Request)

type TargetEncryption

+ KeyRingID string

+ KeyRingName string

type TargetEncryptionRequest

+ KeyRingID string

Oct 15, 2026

Changes in this version

+ type AgentUpdate struct

+ SHA256 string

+ URL string

+ Version string

type HeartbeatRequest

+ SelfUpdate bool

+ UpdateError string

type HeartbeatResponse

+ Update *AgentUpdate

type ServerAPI

+ Updates *agentupdate.Cache

+ func (s *ServerAPI) HandleAgentUpdateBinary(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRequestAgentUpdate(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleSetAgentAutoUpdate(w http.ResponseWriter, r *http.Request)

Oct 10, 2026

Changes in this version

type ServerAPI

+ func (s *ServerAPI) HandleCreateTenant(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleDeleteTenant(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetTenant(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListTenants(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleM365Credentials(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleSubTicket(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleTestTenant(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleUpdateTenant(w http.ResponseWriter, r *http.Request)

+ type SubTicketRequest struct

+ BackupID string

+ VolumeBackupID string

+ type SubTicketResponse = VolumeTicketResponse

+ type TenantRequest struct

+ CertificatePEM string

+ KeyPEM string

+ Secret string

Oct 9, 2026

Changes in this version

+ type AgentEncryptionKey struct

+ Fingerprint string

+ Key string

+ KeyCreatedAt time.Time

+ MasterPublicKey string

+ Mode string

type CreateTargetRequest

+ EncryptionMode string

+ MasterPublicKey *string

+ type ExportKeyRequest struct

+ Hint string

+ KeyID string

+ Passphrase string

+ type ImportKeyRequest struct

+ KeyFile string

+ Passphrase string

type ServerAPI

+ func (s *ServerAPI) HandleAgentEncryptionKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleExportTargetKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetTargetEncryption(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleImportTargetKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRotateTargetKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleSetTargetEncryption(w http.ResponseWriter, r *http.Request)

+ type TargetEncryption struct

+ Fingerprint string

+ HasMasterKey bool

+ KeyCreatedAt *time.Time

+ Keys []*db.TargetKey

+ MasterPublicKey string

+ Mode string

+ type TargetEncryptionRequest struct

+ MasterPublicKey string

+ Mode string

Sep 23, 2026

Changes in this version

type HeartbeatRequest

+ Inventory json.RawMessage

type ServerAPI

+ func (s *ServerAPI) HandleAgentInventory(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleAgentLogs(w http.ResponseWriter, r *http.Request)

Sep 20, 2026

Changes in this version

type EnrollRequest

+ DBEngines []string

type HeartbeatRequest

+ DBEngines []string

Sep 18, 2026

Changes in this version

+ type CloneTargetRequest struct

+ Name string

+ Namespace string

+ PxarFormat string

type ServerAPI

+ func (s *ServerAPI) HandleCloneTarget(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetToken(w http.ResponseWriter, r *http.Request)

Sep 17, 2026

Changes in this version

type EnrollRequest

+ DBTools bool

type HeartbeatRequest

+ DBTools bool

+ type MergeAgentRequest struct

+ Into uuid.UUID

+ type MergeAgentResponse struct

+ From uuid.UUID

+ Into uuid.UUID

+ JobsMoved int64

+ RunsMoved int64

+ Status string

type ServerAPI

+ func (s *ServerAPI) HandleMergeAgent(w http.ResponseWriter, r *http.Request)

Sep 17, 2026

Changes in this version

type EnrollRequest

+ DockerHost bool

type HeartbeatRequest

+ DockerHost bool

Sep 13, 2026

Changes in this version

type EnrollRequest

+ PVEHost bool

type HeartbeatRequest

+ PVEHost bool

type ServerAPI

+ func (s *ServerAPI) HandleRefreshTicket(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleTargetCredentials(w http.ResponseWriter, r *http.Request)

+ type TargetCredentials struct

+ Datastore string

+ Endpoint string

+ Fingerprint string

+ Namespace string

+ Repository string

+ Secret string

+ TLSVerify bool

+ TokenID string

+ type TicketRefreshResponse struct

+ BackupTime int64

+ Ticket string

type VolumeTicketResponse

+ BackupTime int64

Sep 6, 2026

Changes in this version

+ type RunProgressRequest struct

+ Items map[string]rundetail.ProgressItem

+ Phase string

+ RunID uuid.UUID

type ServerAPI

+ func (s *ServerAPI) HandleRunProgress(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleUpdateTarget(w http.ResponseWriter, r *http.Request)

Sep 5, 2026

Changes in this version

type ServerAPI

+ func (s *ServerAPI) HandleVolumeTicket(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleWorkerToken(w http.ResponseWriter, r *http.Request)

+ type VolumeTicketRequest struct

+ VolumeBackupID string

+ type VolumeTicketResponse struct

+ Ticket string

+ type WorkerTokenResponse struct

+ AuthToken string

+ TokenExpiresAt time.Time

Sep 4, 2026

Changes in this version

+ type HeartbeatResponse struct

+ DebugLogging bool

+ Status string

+ type JobScheduler interface

+ Remove func(ctx context.Context, jobID uuid.UUID) error

+ Sync func(ctx context.Context, job *db.BackupJob) error

type ServerAPI

+ Scheduler JobScheduler

+ func (s *ServerAPI) HandleSetAgentDebug(w http.ResponseWriter, r *http.Request)

+ type SetAgentDebugRequest struct

+ Enabled bool

Sep 4, 2026

Changes in this version

+ const BackupTicketHeader

+ type CreateTargetRequest struct

+ AuthToken string

+ Datastore string

+ Endpoint string

+ Fingerprint string

+ Name string

+ Namespace string

+ PxarFormat string

+ TLSVerify bool

+ TargetType string

+ type DBCredentials struct

+ Password string

type EnrollRequest

+ AgentType string

+ type PBSCredentials struct

+ APIToken string

+ Datastore string

+ Endpoint string

+ Fingerprint string

+ Namespace string

+ TLSVerify bool

type ServerAPI

+ func (s *ServerAPI) HandleDBCredentials(w http.ResponseWriter, r *http.Request)

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

+ func (s *ServerAPI) HandlePBSCredentials(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleUpdateJob(w http.ResponseWriter, r *http.Request)

Aug 26, 2026

Changes in this version

type ServerAPI

+ func (s *ServerAPI) HandleCancelRun(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetRun(w http.ResponseWriter, r *http.Request)

Aug 26, 2026

Changes in this version

+ type CreateAPIKeyRequest struct

+ ExpiresAt *time.Time

+ Name string

+ type CreateAPIKeyResponse struct

+ ExpiresAt *time.Time

+ ID uuid.UUID

+ Name string

+ RawKey string

+ type CreateTokenRequest struct

+ ExpiresAt time.Time

+ MaxUses int

+ Name string

+ type CreateTokenResponse struct

+ ExpiresAt time.Time

+ ID uuid.UUID

+ MaxUses int

+ Name string

+ RawToken string

+ type EnrollRequest struct

+ Arch string

+ Hostname string

+ IPAddress string

+ OS string

+ Token string

+ Version string

+ type EnrollResponse struct

+ AgentID uuid.UUID

+ AuthToken string

+ Namespace string

+ ProxyURL string

+ ServerCAPEM string

+ ServerURL string

+ TaskQueue string

+ TokenExpiresAt time.Time

+ type HeartbeatRequest struct

+ AgentID uuid.UUID

+ Status string

+ Version string

+ type MeResponse struct

+ Email string

+ Kind string

+ Name string

+ Subject string

+ type Middleware = func(http.Handler) http.Handler

+ type RotateTokenResponse struct

+ AuthToken string

+ TokenExpiresAt time.Time

+ type ServerAPI struct

+ Config *config.ServerConfig

+ DB *db.DB

+ Temporal client.Client

+ TokenManager *auth.TokenManager

+ Verifier *auth.AgentVerifier

+ func NewServerAPI(database *db.DB, temporalClient client.Client, cfg *config.ServerConfig, ...) *ServerAPI

+ func (s *ServerAPI) HandleAgentEnroll(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleAgentHeartbeat(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleCreateAPIKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleCreateJob(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleCreateTarget(w http.ResponseWriter, r *http.Request)

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

+ func (s *ServerAPI) HandleDeleteAgent(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleDeleteJob(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleDeleteTarget(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetAgent(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetJob(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleGetTarget(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleHealth(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListAPIKeys(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListAgents(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListJobs(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListRuns(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListTargets(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleListTokens(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleMe(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRevokeAPIKey(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleRotateAgentToken(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) HandleTriggerJob(w http.ResponseWriter, r *http.Request)

+ func (s *ServerAPI) RegisterRoutes(r chi.Router, admin, agent Middleware)