Documentation
¶
Overview ¶
Package openapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.
Index ¶
- Constants
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type Agent
- type AgentCertificateRecoveryGrant
- type AgentCertificateRecoveryGrantStatus
- type AgentConfigResponse
- type AgentList
- type AgentRuntime
- type ApplyAccepted
- type ApplyAgentConfig202JSONResponse
- type ApplyAgentConfig400JSONResponse
- type ApplyAgentConfig401JSONResponse
- type ApplyAgentConfig404JSONResponse
- type ApplyAgentConfigJSONBody
- type ApplyAgentConfigJSONBodyReloadMode
- type ApplyAgentConfigJSONRequestBody
- type ApplyAgentConfigRequestObject
- type ApplyAgentConfigResponseObject
- type ApplyGroupConfig202JSONResponse
- type ApplyGroupConfig400JSONResponse
- type ApplyGroupConfig401JSONResponse
- type ApplyGroupConfig404JSONResponse
- type ApplyGroupConfigJSONBody
- type ApplyGroupConfigJSONBodyReloadMode
- type ApplyGroupConfigJSONRequestBody
- type ApplyGroupConfigRequestObject
- type ApplyGroupConfigResponseObject
- type BadRequest
- type BadRequestJSONResponse
- type ChiServerOptions
- type ConfigDrift
- type ConfigDriftStatus
- type ConnectionClassCount
- type CreateAgentCertificateRecoveryGrant201JSONResponse
- type CreateAgentCertificateRecoveryGrant400JSONResponse
- type CreateAgentCertificateRecoveryGrant401JSONResponse
- type CreateAgentCertificateRecoveryGrant403JSONResponse
- type CreateAgentCertificateRecoveryGrant404JSONResponse
- type CreateAgentCertificateRecoveryGrantJSONRequestBody
- type CreateAgentCertificateRecoveryGrantRequestObject
- type CreateAgentCertificateRecoveryGrantResponseObject
- type CreateCertificateRecoveryGrantRequest
- type CreateEnrollmentToken201JSONResponse
- type CreateEnrollmentToken400JSONResponse
- type CreateEnrollmentToken401JSONResponse
- type CreateEnrollmentToken403JSONResponse
- type CreateEnrollmentTokenJSONRequestBody
- type CreateEnrollmentTokenRequest
- type CreateEnrollmentTokenRequestObject
- type CreateEnrollmentTokenResponse
- type CreateEnrollmentTokenResponseObject
- type DeregisterAgent204Response
- type DeregisterAgent401JSONResponse
- type DeregisterAgent403JSONResponse
- type DeregisterAgent404JSONResponse
- type DeregisterAgentRequestObject
- type DeregisterAgentResponseObject
- type DispatchAgentUpdate200JSONResponse
- type DispatchAgentUpdate400JSONResponse
- type DispatchAgentUpdate401JSONResponse
- type DispatchAgentUpdate404JSONResponse
- type DispatchAgentUpdateJSONRequestBody
- type DispatchAgentUpdateRequest
- type DispatchAgentUpdateRequestObject
- type DispatchAgentUpdateResponse
- type DispatchAgentUpdateResponseObject
- type DispatchTelemtUpdate202JSONResponse
- type DispatchTelemtUpdate400JSONResponse
- type DispatchTelemtUpdate401JSONResponse
- type DispatchTelemtUpdate403JSONResponse
- type DispatchTelemtUpdate404JSONResponse
- type DispatchTelemtUpdate409JSONResponse
- type DispatchTelemtUpdateError
- type DispatchTelemtUpdateErrorCode
- type DispatchTelemtUpdateJSONRequestBody
- type DispatchTelemtUpdateRequest
- type DispatchTelemtUpdateRequestObject
- type DispatchTelemtUpdateResponse
- type DispatchTelemtUpdateResponseObject
- type EnrollmentTokenList
- type EnrollmentTokenListItem
- type EnrollmentTokenListItemStatus
- type Error
- type Forbidden
- type ForbiddenJSONResponse
- type GetAgentConfig200JSONResponse
- type GetAgentConfig401JSONResponse
- type GetAgentConfig403JSONResponse
- type GetAgentConfig404JSONResponse
- type GetAgentConfigRequestObject
- type GetAgentConfigResponseObject
- type GetHealthz200TextResponse
- type GetHealthzRequestObject
- type GetHealthzResponseObject
- type GetTelemtUpdateStrategy200JSONResponse
- type GetTelemtUpdateStrategy401JSONResponse
- type GetTelemtUpdateStrategy403JSONResponse
- type GetTelemtUpdateStrategy404JSONResponse
- type GetTelemtUpdateStrategyRequestObject
- type GetTelemtUpdateStrategyResponseObject
- type GetVersion200JSONResponse
- type GetVersion401JSONResponse
- type GetVersionRequestObject
- type GetVersionResponseObject
- type InstallCommandAdvancedOptions
- type InvalidParamFormatError
- type ListAgents200JSONResponse
- type ListAgents401JSONResponse
- type ListAgents403JSONResponse
- type ListAgentsRequestObject
- type ListAgentsResponseObject
- type ListEnrollmentTokens200JSONResponse
- type ListEnrollmentTokens401JSONResponse
- type ListEnrollmentTokens403JSONResponse
- type ListEnrollmentTokensRequestObject
- type ListEnrollmentTokensResponseObject
- type MiddlewareFunc
- type NotFound
- type NotFoundJSONResponse
- type ProvisionOutboundAgent201JSONResponse
- type ProvisionOutboundAgent400JSONResponse
- type ProvisionOutboundAgent401JSONResponse
- type ProvisionOutboundAgent403JSONResponse
- type ProvisionOutboundAgent409JSONResponse
- type ProvisionOutboundAgent503TextResponse
- type ProvisionOutboundAgentJSONRequestBody
- type ProvisionOutboundAgentRequest
- type ProvisionOutboundAgentRequestObject
- type ProvisionOutboundAgentRequestScriptSource
- type ProvisionOutboundAgentResponse
- type ProvisionOutboundAgentResponseObject
- type PutTelemtUpdateStrategy204Response
- type PutTelemtUpdateStrategy400JSONResponse
- type PutTelemtUpdateStrategy401JSONResponse
- type PutTelemtUpdateStrategy403JSONResponse
- type PutTelemtUpdateStrategy404JSONResponse
- type PutTelemtUpdateStrategyJSONRequestBody
- type PutTelemtUpdateStrategyRequestObject
- type PutTelemtUpdateStrategyResponseObject
- type RenameAgent200JSONResponse
- type RenameAgent400JSONResponse
- type RenameAgent401JSONResponse
- type RenameAgent404JSONResponse
- type RenameAgentJSONRequestBody
- type RenameAgentRequest
- type RenameAgentRequestObject
- type RenameAgentResponseObject
- type RequiredHeaderError
- type RequiredParamError
- type RevokeAgentCertificateRecoveryGrant200JSONResponse
- type RevokeAgentCertificateRecoveryGrant401JSONResponse
- type RevokeAgentCertificateRecoveryGrant403JSONResponse
- type RevokeAgentCertificateRecoveryGrant404JSONResponse
- type RevokeAgentCertificateRecoveryGrantRequestObject
- type RevokeAgentCertificateRecoveryGrantResponseObject
- type RevokeEnrollmentToken204Response
- type RevokeEnrollmentToken401JSONResponse
- type RevokeEnrollmentToken403JSONResponse
- type RevokeEnrollmentToken404JSONResponse
- type RevokeEnrollmentTokenRequestObject
- type RevokeEnrollmentTokenResponseObject
- type RuntimeDC
- type RuntimeEvent
- type RuntimeMeWritersSummary
- type RuntimeSystemLoad
- type RuntimeTopByConnections
- type RuntimeTopByThroughput
- type RuntimeUpstream
- type ScriptSource
- type ScriptSources
- type SelfUpdateState
- type SelfUpdateStatePhase
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) ApplyAgentConfig(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ApplyGroupConfig(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateEnrollmentToken(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeregisterAgent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DispatchAgentUpdate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DispatchTelemtUpdate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetAgentConfig(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetHealthz(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetVersion(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListAgents(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListEnrollmentTokens(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ProvisionOutboundAgent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PutTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RenameAgent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RevokeAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RevokeEnrollmentToken(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpdateAgentFleetGroup(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpdateAgentTransportMode(w http.ResponseWriter, r *http.Request)
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type TelemtUpdateProbe
- type TelemtUpdateStrategy
- type TelemtUpdateStrategyMode
- type TelemtUpdateStrategyResponse
- type TooManyValuesForParamError
- type Unauthorized
- type UnauthorizedJSONResponse
- type UnescapedCookieParamError
- type Unimplemented
- func (_ Unimplemented) ApplyAgentConfig(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) ApplyGroupConfig(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) CreateAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) CreateEnrollmentToken(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) DeregisterAgent(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) DispatchAgentUpdate(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) DispatchTelemtUpdate(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) GetAgentConfig(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) GetHealthz(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) GetVersion(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) ListAgents(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) ListEnrollmentTokens(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) ProvisionOutboundAgent(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PutTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) RenameAgent(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) RevokeAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) RevokeEnrollmentToken(w http.ResponseWriter, r *http.Request, value string)
- func (_ Unimplemented) UpdateAgentFleetGroup(w http.ResponseWriter, r *http.Request, id string)
- func (_ Unimplemented) UpdateAgentTransportMode(w http.ResponseWriter, r *http.Request, id string)
- type UnmarshalingParamError
- type UpdateAgentFleetGroup200JSONResponse
- type UpdateAgentFleetGroup400JSONResponse
- type UpdateAgentFleetGroup401JSONResponse
- type UpdateAgentFleetGroup403JSONResponse
- type UpdateAgentFleetGroup404JSONResponse
- type UpdateAgentFleetGroupJSONRequestBody
- type UpdateAgentFleetGroupRequest
- type UpdateAgentFleetGroupRequestObject
- type UpdateAgentFleetGroupResponseObject
- type UpdateAgentTransportMode204Response
- type UpdateAgentTransportMode400JSONResponse
- type UpdateAgentTransportMode401JSONResponse
- type UpdateAgentTransportMode404JSONResponse
- type UpdateAgentTransportModeJSONRequestBody
- type UpdateAgentTransportModeRequest
- type UpdateAgentTransportModeRequestObject
- type UpdateAgentTransportModeRequestTransportMode
- type UpdateAgentTransportModeResponseObject
- type VersionResponse
Constants ¶
const (
SessionCookieScopes sessionCookieContextKey = "sessionCookie.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetSpec ¶
GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.
func GetSpecJSON ¶
GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.
func GetSwagger
deprecated
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type Agent ¶
type Agent struct {
// BootstrapState Enrollment lifecycle state of the agents row: "pending"
// (provisioned, awaiting first enrollment), "expired" (bootstrap
// token lapsed before enrollment) or "active" (enrolled). Empty for
// legacy inbound rows. Meaningful for the UI only while the node has
// never connected — a half-added node renders as pending/expired
// instead of offline (R9a).
BootstrapState *string `json:"bootstrap_state,omitempty"`
// CertExpiresAt Expiry timestamp of the agent's current certificate.
CertExpiresAt *time.Time `json:"cert_expires_at,omitempty"`
// CertIssuedAt Issuance timestamp of the agent's current certificate.
CertIssuedAt *time.Time `json:"cert_issued_at,omitempty"`
// CertificateRecovery Optional snapshot of any active certificate-recovery grant
// for the agent. Absent when no grant has been issued.
CertificateRecovery *AgentCertificateRecoveryGrant `json:"certificate_recovery,omitempty"`
// DialTransportMode Persisted transport mode of the agents row — "inbound" (agent
// dials the panel) or "outbound" (panel dials the agent). Distinct
// from runtime.transport_mode (Telemt classic/middle_proxy).
DialTransportMode *string `json:"dial_transport_mode,omitempty"`
// FleetGroupId UUID of the fleet group the agent belongs to.
FleetGroupId string `json:"fleet_group_id"`
// Id Agent UUID.
Id string `json:"id"`
// LastSeenAt Last successful heartbeat timestamp.
LastSeenAt time.Time `json:"last_seen_at"`
// NodeName Operator-facing display name.
NodeName string `json:"node_name"`
// PresenceState Live presence evaluation — `online`, `flapping`, `offline`, etc.
// Computed at request time from session + heartbeat data.
PresenceState string `json:"presence_state"`
// ReadOnly True when the agent serves read-only Telemt instances.
ReadOnly bool `json:"read_only"`
// Runtime Telemt operator overview reported by the agent. The set of
// fields is defensive on the Zod side because backends can ship
// new counters without an immediate web release; on the spec
// side we list every field the panel currently consumes.
Runtime AgentRuntime `json:"runtime"`
// TelemtUpdateProbe Whether (and how) this node's telemt install can be updated
// in place: which process supervisor fronts it, and — when no
// in-place path exists — why. Cached by the agent once at
// process startup and stamped on every snapshot; absent until
// the agent has sent at least one such snapshot (older agents
// that predate the probe never populate it).
TelemtUpdateProbe *TelemtUpdateProbe `json:"telemt_update_probe,omitempty"`
// TransportDrift True when the direction of the last accepted stream disagreed with
// dial_transport_mode — the agent is still dialing IN while the DB
// says outbound, or vice versa (R-4). The panel re-enqueues the
// switch job to converge; cleared once a session connects in the
// direction the DB expects.
TransportDrift *bool `json:"transport_drift,omitempty"`
// TransportReconnectPending True when the agent was switched to outbound transport but the
// panel has not accepted a session from/to it since the switch
// ("switched but never reconnected"). Cleared on the next accepted
// agent stream.
TransportReconnectPending *bool `json:"transport_reconnect_pending,omitempty"`
// Version Agent binary semver as last reported.
Version string `json:"version"`
}
Agent Control-plane snapshot of one enrolled agent. Mirrors the Go `server.Agent` struct (`internal/controlplane/server/types.go`).
type AgentCertificateRecoveryGrant ¶
type AgentCertificateRecoveryGrant struct {
AgentId string `json:"agent_id"`
ExpiresAtUnix int64 `json:"expires_at_unix"`
IssuedAtUnix int64 `json:"issued_at_unix"`
RevokedAtUnix *int64 `json:"revoked_at_unix,omitempty"`
Status AgentCertificateRecoveryGrantStatus `json:"status"`
UsedAtUnix *int64 `json:"used_at_unix,omitempty"`
}
AgentCertificateRecoveryGrant Lifecycle snapshot of a single recovery grant.
type AgentCertificateRecoveryGrantStatus ¶
type AgentCertificateRecoveryGrantStatus string
AgentCertificateRecoveryGrantStatus defines model for AgentCertificateRecoveryGrant.Status.
const ( AgentCertificateRecoveryGrantStatusAllowed AgentCertificateRecoveryGrantStatus = "allowed" AgentCertificateRecoveryGrantStatusExpired AgentCertificateRecoveryGrantStatus = "expired" AgentCertificateRecoveryGrantStatusRevoked AgentCertificateRecoveryGrantStatus = "revoked" AgentCertificateRecoveryGrantStatusUsed AgentCertificateRecoveryGrantStatus = "used" )
Defines values for AgentCertificateRecoveryGrantStatus.
func (AgentCertificateRecoveryGrantStatus) Valid ¶
func (e AgentCertificateRecoveryGrantStatus) Valid() bool
Valid indicates whether the value is a known member of the AgentCertificateRecoveryGrantStatus enum.
type AgentConfigResponse ¶
type AgentConfigResponse struct {
Desired map[string]interface{} `json:"desired"`
// Drift Drift summary attached to a config GET response. `fields` lists
// the dotted paths that drift; it is empty unless `status` is
// `drifted`.
Drift ConfigDrift `json:"drift"`
Effective map[string]interface{} `json:"effective"`
GroupPaths []string `json:"group_paths"`
Observed map[string]interface{} `json:"observed"`
}
AgentConfigResponse GET /api/agents/{id}/config response. Mirrors the Go `agentConfigTargetResponse` struct (`internal/controlplane/server/http_config_targets.go`). `desired` is the agent's own stored config snapshot (stripped of the internal schema-version marker), `effective` is the fleet-group sections deep-merged with `desired`, `observed` is the node's last-reported editable sections, `drift` compares `desired` against `observed`, and `group_paths` lists the flattened dotted paths the node's fleet group governs (so the UI can lock those fields).
type AgentRuntime ¶
type AgentRuntime struct {
AcceptingNewConnections bool `json:"accepting_new_connections"`
ActiveUsers int `json:"active_users"`
ConfiguredUsers int `json:"configured_users"`
ConnectAttemptTotal int64 `json:"connect_attempt_total"`
ConnectFailTotal int64 `json:"connect_fail_total"`
ConnectFailfastTotal int64 `json:"connect_failfast_total"`
ConnectSuccessTotal int64 `json:"connect_success_total"`
// ConnectionsBadByClass Per-class breakdown of bad connections (Telemt 3.4.10+). The
// class set is open-ended. Backend emits `null` (not `[]`) when
// no breakdown has been observed yet — absence means "unknown".
ConnectionsBadByClass *[]ConnectionClassCount `json:"connections_bad_by_class,omitempty"`
ConnectionsBadTotal int64 `json:"connections_bad_total"`
ConnectionsTotal int64 `json:"connections_total"`
CurrentConnections int `json:"current_connections"`
CurrentConnectionsDirect int `json:"current_connections_direct"`
CurrentConnectionsMe int `json:"current_connections_me"`
DcCoveragePct float64 `json:"dc_coverage_pct"`
Dcs []RuntimeDC `json:"dcs"`
Degraded bool `json:"degraded"`
DirectUpstreams *int `json:"direct_upstreams,omitempty"`
FailRateKnown bool `json:"fail_rate_known"`
// FailRatePct5m 5-minute upstream connect fail-rate. Read together with
// `fail_rate_known`: `false` means "unknown", not "0%".
FailRatePct5m float64 `json:"fail_rate_pct_5m"`
// FallbackEnteredAtUnix Unix timestamp the panel observed this agent enter
// ME→DC fallback. Absent when not in fallback.
FallbackEnteredAtUnix *int64 `json:"fallback_entered_at_unix,omitempty"`
// HandshakeFailuresByClass Per-class breakdown of handshake failures (Telemt 3.4.10+).
// Same null-vs-empty semantics as connections_bad_by_class.
HandshakeFailuresByClass *[]ConnectionClassCount `json:"handshake_failures_by_class,omitempty"`
HandshakeTimeoutsTotal int64 `json:"handshake_timeouts_total"`
HealthyUpstreams int `json:"healthy_upstreams"`
InitializationProgressPct float64 `json:"initialization_progress_pct"`
InitializationStage string `json:"initialization_stage"`
InitializationStatus string `json:"initialization_status"`
LifecycleState *string `json:"lifecycle_state,omitempty"`
Me2dcFallbackEnabled bool `json:"me2dc_fallback_enabled"`
Me2dcFastEnabled *bool `json:"me2dc_fast_enabled,omitempty"`
MeRuntimeReady bool `json:"me_runtime_ready"`
MeWritersSummary *RuntimeMeWritersSummary `json:"me_writers_summary,omitempty"`
RecentEvents []RuntimeEvent `json:"recent_events"`
RerouteActive *bool `json:"reroute_active,omitempty"`
RouteMode *string `json:"route_mode,omitempty"`
ShadowsocksUpstreams *int `json:"shadowsocks_upstreams,omitempty"`
Socks4Upstreams *int `json:"socks4_upstreams,omitempty"`
Socks5Upstreams *int `json:"socks5_upstreams,omitempty"`
StaleCacheUsed *bool `json:"stale_cache_used,omitempty"`
StartupProgressPct float64 `json:"startup_progress_pct"`
StartupStage string `json:"startup_stage"`
StartupStatus string `json:"startup_status"`
SystemLoad RuntimeSystemLoad `json:"system_load"`
TelemtUnreachable bool `json:"telemt_unreachable"`
TelemtUnreachableSinceUnix int64 `json:"telemt_unreachable_since_unix"`
TopByConnections *[]RuntimeTopByConnections `json:"top_by_connections,omitempty"`
TopByThroughput *[]RuntimeTopByThroughput `json:"top_by_throughput,omitempty"`
TotalUpstreams int `json:"total_upstreams"`
TransportMode string `json:"transport_mode"`
UnhealthyUpstreams *int `json:"unhealthy_upstreams,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
Upstreams []RuntimeUpstream `json:"upstreams"`
UptimeSeconds float64 `json:"uptime_seconds"`
UseMiddleProxy bool `json:"use_middle_proxy"`
UserTelemetrySuppressed bool `json:"user_telemetry_suppressed"`
}
AgentRuntime Telemt operator overview reported by the agent. The set of fields is defensive on the Zod side because backends can ship new counters without an immediate web release; on the spec side we list every field the panel currently consumes.
type ApplyAccepted ¶
type ApplyAccepted struct {
BatchId string `json:"batch_id"`
}
ApplyAccepted 202 body returned by the async config-apply handlers (single agent and group fan-out). Mirrors the Go `groupApplyAcceptedResponse` struct (`internal/controlplane/server/http_config_apply.go`). Poll the corresponding `.../config/apply/batches/{batchId}` endpoint for status.
type ApplyAgentConfig202JSONResponse ¶
type ApplyAgentConfig202JSONResponse ApplyAccepted
func (ApplyAgentConfig202JSONResponse) VisitApplyAgentConfigResponse ¶
func (response ApplyAgentConfig202JSONResponse) VisitApplyAgentConfigResponse(w http.ResponseWriter) error
type ApplyAgentConfig400JSONResponse ¶
type ApplyAgentConfig400JSONResponse struct{ BadRequestJSONResponse }
func (ApplyAgentConfig400JSONResponse) VisitApplyAgentConfigResponse ¶
func (response ApplyAgentConfig400JSONResponse) VisitApplyAgentConfigResponse(w http.ResponseWriter) error
type ApplyAgentConfig401JSONResponse ¶
func (ApplyAgentConfig401JSONResponse) VisitApplyAgentConfigResponse ¶
func (response ApplyAgentConfig401JSONResponse) VisitApplyAgentConfigResponse(w http.ResponseWriter) error
type ApplyAgentConfig404JSONResponse ¶
type ApplyAgentConfig404JSONResponse struct{ NotFoundJSONResponse }
func (ApplyAgentConfig404JSONResponse) VisitApplyAgentConfigResponse ¶
func (response ApplyAgentConfig404JSONResponse) VisitApplyAgentConfigResponse(w http.ResponseWriter) error
type ApplyAgentConfigJSONBody ¶
type ApplyAgentConfigJSONBody struct {
// Paths Optional dotted config paths to restrict the apply to. Absent or empty pushes every drifted leaf.
Paths *[]string `json:"paths,omitempty"`
ReloadMode *ApplyAgentConfigJSONBodyReloadMode `json:"reload_mode,omitempty"`
ReloadTimeoutSecs *int `json:"reload_timeout_secs,omitempty"`
}
ApplyAgentConfigJSONBody defines parameters for ApplyAgentConfig.
type ApplyAgentConfigJSONBodyReloadMode ¶
type ApplyAgentConfigJSONBodyReloadMode string
ApplyAgentConfigJSONBodyReloadMode defines parameters for ApplyAgentConfig.
const ( ApplyAgentConfigJSONBodyReloadModeDrain ApplyAgentConfigJSONBodyReloadMode = "drain" ApplyAgentConfigJSONBodyReloadModeInstant ApplyAgentConfigJSONBodyReloadMode = "instant" )
Defines values for ApplyAgentConfigJSONBodyReloadMode.
func (ApplyAgentConfigJSONBodyReloadMode) Valid ¶
func (e ApplyAgentConfigJSONBodyReloadMode) Valid() bool
Valid indicates whether the value is a known member of the ApplyAgentConfigJSONBodyReloadMode enum.
type ApplyAgentConfigJSONRequestBody ¶
type ApplyAgentConfigJSONRequestBody ApplyAgentConfigJSONBody
ApplyAgentConfigJSONRequestBody defines body for ApplyAgentConfig for application/json ContentType.
type ApplyAgentConfigRequestObject ¶
type ApplyAgentConfigRequestObject struct {
Id string `json:"id"`
Body *ApplyAgentConfigJSONRequestBody
}
type ApplyAgentConfigResponseObject ¶
type ApplyAgentConfigResponseObject interface {
VisitApplyAgentConfigResponse(w http.ResponseWriter) error
}
type ApplyGroupConfig202JSONResponse ¶
type ApplyGroupConfig202JSONResponse ApplyAccepted
func (ApplyGroupConfig202JSONResponse) VisitApplyGroupConfigResponse ¶
func (response ApplyGroupConfig202JSONResponse) VisitApplyGroupConfigResponse(w http.ResponseWriter) error
type ApplyGroupConfig400JSONResponse ¶
type ApplyGroupConfig400JSONResponse struct{ BadRequestJSONResponse }
func (ApplyGroupConfig400JSONResponse) VisitApplyGroupConfigResponse ¶
func (response ApplyGroupConfig400JSONResponse) VisitApplyGroupConfigResponse(w http.ResponseWriter) error
type ApplyGroupConfig401JSONResponse ¶
func (ApplyGroupConfig401JSONResponse) VisitApplyGroupConfigResponse ¶
func (response ApplyGroupConfig401JSONResponse) VisitApplyGroupConfigResponse(w http.ResponseWriter) error
type ApplyGroupConfig404JSONResponse ¶
type ApplyGroupConfig404JSONResponse struct{ NotFoundJSONResponse }
func (ApplyGroupConfig404JSONResponse) VisitApplyGroupConfigResponse ¶
func (response ApplyGroupConfig404JSONResponse) VisitApplyGroupConfigResponse(w http.ResponseWriter) error
type ApplyGroupConfigJSONBody ¶
type ApplyGroupConfigJSONBody struct {
ReloadMode *ApplyGroupConfigJSONBodyReloadMode `json:"reload_mode,omitempty"`
ReloadTimeoutSecs *int `json:"reload_timeout_secs,omitempty"`
}
ApplyGroupConfigJSONBody defines parameters for ApplyGroupConfig.
type ApplyGroupConfigJSONBodyReloadMode ¶
type ApplyGroupConfigJSONBodyReloadMode string
ApplyGroupConfigJSONBodyReloadMode defines parameters for ApplyGroupConfig.
const ( ApplyGroupConfigJSONBodyReloadModeDrain ApplyGroupConfigJSONBodyReloadMode = "drain" ApplyGroupConfigJSONBodyReloadModeInstant ApplyGroupConfigJSONBodyReloadMode = "instant" )
Defines values for ApplyGroupConfigJSONBodyReloadMode.
func (ApplyGroupConfigJSONBodyReloadMode) Valid ¶
func (e ApplyGroupConfigJSONBodyReloadMode) Valid() bool
Valid indicates whether the value is a known member of the ApplyGroupConfigJSONBodyReloadMode enum.
type ApplyGroupConfigJSONRequestBody ¶
type ApplyGroupConfigJSONRequestBody ApplyGroupConfigJSONBody
ApplyGroupConfigJSONRequestBody defines body for ApplyGroupConfig for application/json ContentType.
type ApplyGroupConfigRequestObject ¶
type ApplyGroupConfigRequestObject struct {
Id string `json:"id"`
Body *ApplyGroupConfigJSONRequestBody
}
type ApplyGroupConfigResponseObject ¶
type ApplyGroupConfigResponseObject interface {
VisitApplyGroupConfigResponse(w http.ResponseWriter) error
}
type BadRequest ¶
type BadRequest = Error
BadRequest Standard error envelope used by every 4xx / 5xx response.
type BadRequestJSONResponse ¶
type BadRequestJSONResponse Error
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type ConfigDrift ¶
type ConfigDrift struct {
Fields []string `json:"fields"`
Status ConfigDriftStatus `json:"status"`
}
ConfigDrift Drift summary attached to a config GET response. `fields` lists the dotted paths that drift; it is empty unless `status` is `drifted`.
type ConfigDriftStatus ¶
type ConfigDriftStatus string
ConfigDriftStatus defines model for ConfigDrift.Status.
const ( Drifted ConfigDriftStatus = "drifted" InSync ConfigDriftStatus = "in_sync" Unknown ConfigDriftStatus = "unknown" )
Defines values for ConfigDriftStatus.
func (ConfigDriftStatus) Valid ¶
func (e ConfigDriftStatus) Valid() bool
Valid indicates whether the value is a known member of the ConfigDriftStatus enum.
type ConnectionClassCount ¶
ConnectionClassCount One (class, total) pair from Telemt's classified bad-connection and handshake-failure counters. Mirrors the Go `ConnectionClassCount` presentation type.
type CreateAgentCertificateRecoveryGrant201JSONResponse ¶
type CreateAgentCertificateRecoveryGrant201JSONResponse AgentCertificateRecoveryGrant
func (CreateAgentCertificateRecoveryGrant201JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse ¶
func (response CreateAgentCertificateRecoveryGrant201JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type CreateAgentCertificateRecoveryGrant400JSONResponse ¶
type CreateAgentCertificateRecoveryGrant400JSONResponse struct{ BadRequestJSONResponse }
func (CreateAgentCertificateRecoveryGrant400JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse ¶
func (response CreateAgentCertificateRecoveryGrant400JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type CreateAgentCertificateRecoveryGrant401JSONResponse ¶
func (CreateAgentCertificateRecoveryGrant401JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse ¶
func (response CreateAgentCertificateRecoveryGrant401JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type CreateAgentCertificateRecoveryGrant403JSONResponse ¶
type CreateAgentCertificateRecoveryGrant403JSONResponse struct{ ForbiddenJSONResponse }
func (CreateAgentCertificateRecoveryGrant403JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse ¶
func (response CreateAgentCertificateRecoveryGrant403JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type CreateAgentCertificateRecoveryGrant404JSONResponse ¶
type CreateAgentCertificateRecoveryGrant404JSONResponse struct{ NotFoundJSONResponse }
func (CreateAgentCertificateRecoveryGrant404JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse ¶
func (response CreateAgentCertificateRecoveryGrant404JSONResponse) VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type CreateAgentCertificateRecoveryGrantJSONRequestBody ¶
type CreateAgentCertificateRecoveryGrantJSONRequestBody = CreateCertificateRecoveryGrantRequest
CreateAgentCertificateRecoveryGrantJSONRequestBody defines body for CreateAgentCertificateRecoveryGrant for application/json ContentType.
type CreateAgentCertificateRecoveryGrantRequestObject ¶
type CreateAgentCertificateRecoveryGrantRequestObject struct {
Id string `json:"id"`
Body *CreateAgentCertificateRecoveryGrantJSONRequestBody
}
type CreateAgentCertificateRecoveryGrantResponseObject ¶
type CreateAgentCertificateRecoveryGrantResponseObject interface {
VisitCreateAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
}
type CreateCertificateRecoveryGrantRequest ¶
type CreateCertificateRecoveryGrantRequest struct {
// TtlSeconds Grant lifetime in seconds. Zero or omitted yields the
// server's default TTL (15m, capped at 1h).
TtlSeconds *int `json:"ttl_seconds,omitempty"`
}
CreateCertificateRecoveryGrantRequest defines model for CreateCertificateRecoveryGrantRequest.
type CreateEnrollmentToken201JSONResponse ¶
type CreateEnrollmentToken201JSONResponse CreateEnrollmentTokenResponse
func (CreateEnrollmentToken201JSONResponse) VisitCreateEnrollmentTokenResponse ¶
func (response CreateEnrollmentToken201JSONResponse) VisitCreateEnrollmentTokenResponse(w http.ResponseWriter) error
type CreateEnrollmentToken400JSONResponse ¶
type CreateEnrollmentToken400JSONResponse struct{ BadRequestJSONResponse }
func (CreateEnrollmentToken400JSONResponse) VisitCreateEnrollmentTokenResponse ¶
func (response CreateEnrollmentToken400JSONResponse) VisitCreateEnrollmentTokenResponse(w http.ResponseWriter) error
type CreateEnrollmentToken401JSONResponse ¶
func (CreateEnrollmentToken401JSONResponse) VisitCreateEnrollmentTokenResponse ¶
func (response CreateEnrollmentToken401JSONResponse) VisitCreateEnrollmentTokenResponse(w http.ResponseWriter) error
type CreateEnrollmentToken403JSONResponse ¶
type CreateEnrollmentToken403JSONResponse struct{ ForbiddenJSONResponse }
func (CreateEnrollmentToken403JSONResponse) VisitCreateEnrollmentTokenResponse ¶
func (response CreateEnrollmentToken403JSONResponse) VisitCreateEnrollmentTokenResponse(w http.ResponseWriter) error
type CreateEnrollmentTokenJSONRequestBody ¶
type CreateEnrollmentTokenJSONRequestBody = CreateEnrollmentTokenRequest
CreateEnrollmentTokenJSONRequestBody defines body for CreateEnrollmentToken for application/json ContentType.
type CreateEnrollmentTokenRequest ¶
type CreateEnrollmentTokenRequest struct {
// FleetGroupId Either the canonical UUID or the friendly slug; empty
// string falls back to the default fleet group.
FleetGroupId *string `json:"fleet_group_id,omitempty"`
// TtlSeconds Token lifetime in seconds.
TtlSeconds int `json:"ttl_seconds"`
}
CreateEnrollmentTokenRequest defines model for CreateEnrollmentTokenRequest.
type CreateEnrollmentTokenRequestObject ¶
type CreateEnrollmentTokenRequestObject struct {
Body *CreateEnrollmentTokenJSONRequestBody
}
type CreateEnrollmentTokenResponse ¶
type CreateEnrollmentTokenResponse struct {
// CaPem PEM-encoded panel CA certificate.
CaPem string `json:"ca_pem"`
ExpiresAtUnix int64 `json:"expires_at_unix"`
FleetGroupId string `json:"fleet_group_id"`
IssuedAtUnix int64 `json:"issued_at_unix"`
PanelUrl string `json:"panel_url"`
// ScriptSources The two canonical sources from which an agent host can fetch
// the install script. Operators choose between them in the
// Add-Server wizard — Panel for the default inbound case (panel
// is reachable, integrity-checked), GitHub for outbound (panel
// is firewalled from the agent host) or cold-bootstrap.
ScriptSources ScriptSources `json:"script_sources"`
// Value The raw bootstrap token. Returned only at creation.
Value string `json:"value"`
}
CreateEnrollmentTokenResponse Response to a successful `POST /api/agents/enrollment-tokens`. The raw `value` is exposed once at this moment; subsequent listings only carry the masked form.
type CreateEnrollmentTokenResponseObject ¶
type CreateEnrollmentTokenResponseObject interface {
VisitCreateEnrollmentTokenResponse(w http.ResponseWriter) error
}
type DeregisterAgent204Response ¶
type DeregisterAgent204Response struct {
}
func (DeregisterAgent204Response) VisitDeregisterAgentResponse ¶
func (response DeregisterAgent204Response) VisitDeregisterAgentResponse(w http.ResponseWriter) error
type DeregisterAgent401JSONResponse ¶
func (DeregisterAgent401JSONResponse) VisitDeregisterAgentResponse ¶
func (response DeregisterAgent401JSONResponse) VisitDeregisterAgentResponse(w http.ResponseWriter) error
type DeregisterAgent403JSONResponse ¶
type DeregisterAgent403JSONResponse struct{ ForbiddenJSONResponse }
func (DeregisterAgent403JSONResponse) VisitDeregisterAgentResponse ¶
func (response DeregisterAgent403JSONResponse) VisitDeregisterAgentResponse(w http.ResponseWriter) error
type DeregisterAgent404JSONResponse ¶
type DeregisterAgent404JSONResponse struct{ NotFoundJSONResponse }
func (DeregisterAgent404JSONResponse) VisitDeregisterAgentResponse ¶
func (response DeregisterAgent404JSONResponse) VisitDeregisterAgentResponse(w http.ResponseWriter) error
type DeregisterAgentRequestObject ¶
type DeregisterAgentRequestObject struct {
Id string `json:"id"`
}
type DeregisterAgentResponseObject ¶
type DeregisterAgentResponseObject interface {
VisitDeregisterAgentResponse(w http.ResponseWriter) error
}
type DispatchAgentUpdate200JSONResponse ¶
type DispatchAgentUpdate200JSONResponse DispatchAgentUpdateResponse
func (DispatchAgentUpdate200JSONResponse) VisitDispatchAgentUpdateResponse ¶
func (response DispatchAgentUpdate200JSONResponse) VisitDispatchAgentUpdateResponse(w http.ResponseWriter) error
type DispatchAgentUpdate400JSONResponse ¶
type DispatchAgentUpdate400JSONResponse struct{ BadRequestJSONResponse }
func (DispatchAgentUpdate400JSONResponse) VisitDispatchAgentUpdateResponse ¶
func (response DispatchAgentUpdate400JSONResponse) VisitDispatchAgentUpdateResponse(w http.ResponseWriter) error
type DispatchAgentUpdate401JSONResponse ¶
func (DispatchAgentUpdate401JSONResponse) VisitDispatchAgentUpdateResponse ¶
func (response DispatchAgentUpdate401JSONResponse) VisitDispatchAgentUpdateResponse(w http.ResponseWriter) error
type DispatchAgentUpdate404JSONResponse ¶
type DispatchAgentUpdate404JSONResponse struct{ NotFoundJSONResponse }
func (DispatchAgentUpdate404JSONResponse) VisitDispatchAgentUpdateResponse ¶
func (response DispatchAgentUpdate404JSONResponse) VisitDispatchAgentUpdateResponse(w http.ResponseWriter) error
type DispatchAgentUpdateJSONRequestBody ¶
type DispatchAgentUpdateJSONRequestBody = DispatchAgentUpdateRequest
DispatchAgentUpdateJSONRequestBody defines body for DispatchAgentUpdate for application/json ContentType.
type DispatchAgentUpdateRequest ¶
type DispatchAgentUpdateRequest struct {
// Version Target agent binary version.
Version string `json:"version"`
}
DispatchAgentUpdateRequest defines model for DispatchAgentUpdateRequest.
type DispatchAgentUpdateRequestObject ¶
type DispatchAgentUpdateRequestObject struct {
Id string `json:"id"`
Body *DispatchAgentUpdateJSONRequestBody
}
type DispatchAgentUpdateResponse ¶
type DispatchAgentUpdateResponse struct {
JobId string `json:"job_id"`
Status string `json:"status"`
Version string `json:"version"`
}
DispatchAgentUpdateResponse defines model for DispatchAgentUpdateResponse.
type DispatchAgentUpdateResponseObject ¶
type DispatchAgentUpdateResponseObject interface {
VisitDispatchAgentUpdateResponse(w http.ResponseWriter) error
}
type DispatchTelemtUpdate202JSONResponse ¶
type DispatchTelemtUpdate202JSONResponse DispatchTelemtUpdateResponse
func (DispatchTelemtUpdate202JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate202JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdate400JSONResponse ¶
type DispatchTelemtUpdate400JSONResponse struct{ BadRequestJSONResponse }
func (DispatchTelemtUpdate400JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate400JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdate401JSONResponse ¶
func (DispatchTelemtUpdate401JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate401JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdate403JSONResponse ¶
type DispatchTelemtUpdate403JSONResponse struct{ ForbiddenJSONResponse }
func (DispatchTelemtUpdate403JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate403JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdate404JSONResponse ¶
type DispatchTelemtUpdate404JSONResponse struct{ NotFoundJSONResponse }
func (DispatchTelemtUpdate404JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate404JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdate409JSONResponse ¶
type DispatchTelemtUpdate409JSONResponse DispatchTelemtUpdateError
func (DispatchTelemtUpdate409JSONResponse) VisitDispatchTelemtUpdateResponse ¶
func (response DispatchTelemtUpdate409JSONResponse) VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
type DispatchTelemtUpdateError ¶
type DispatchTelemtUpdateError struct {
// Code strategy_not_configured: no update strategy has been PUT for
// this agent yet. mode_not_binary: the configured strategy's mode
// is "docker" or "none" — no in-place binary swap path exists.
// update_unavailable: the agent's live probe reports it cannot
// offer an in-place update right now. no_known_release: no
// version was given and the panel has never cached a latest
// Telemt release.
Code DispatchTelemtUpdateErrorCode `json:"code"`
// Error Human-readable message; safe to display to operators.
Error string `json:"error"`
}
DispatchTelemtUpdateError 409 error envelope for `POST /api/agents/{id}/telemt/update`: `code` is the machine-readable guard that rejected the request.
type DispatchTelemtUpdateErrorCode ¶
type DispatchTelemtUpdateErrorCode string
DispatchTelemtUpdateErrorCode strategy_not_configured: no update strategy has been PUT for this agent yet. mode_not_binary: the configured strategy's mode is "docker" or "none" — no in-place binary swap path exists. update_unavailable: the agent's live probe reports it cannot offer an in-place update right now. no_known_release: no version was given and the panel has never cached a latest Telemt release.
const ( ModeNotBinary DispatchTelemtUpdateErrorCode = "mode_not_binary" NoKnownRelease DispatchTelemtUpdateErrorCode = "no_known_release" StrategyNotConfigured DispatchTelemtUpdateErrorCode = "strategy_not_configured" )
Defines values for DispatchTelemtUpdateErrorCode.
func (DispatchTelemtUpdateErrorCode) Valid ¶
func (e DispatchTelemtUpdateErrorCode) Valid() bool
Valid indicates whether the value is a known member of the DispatchTelemtUpdateErrorCode enum.
type DispatchTelemtUpdateJSONRequestBody ¶
type DispatchTelemtUpdateJSONRequestBody = DispatchTelemtUpdateRequest
DispatchTelemtUpdateJSONRequestBody defines body for DispatchTelemtUpdate for application/json ContentType.
type DispatchTelemtUpdateRequest ¶
type DispatchTelemtUpdateRequest struct {
// AllowDowngrade Allow installing a version older than the one currently
// running (e.g. an emergency rollback). Defaults to false.
AllowDowngrade *bool `json:"allow_downgrade,omitempty"`
// Version Target Telemt version (bare semver, e.g. "3.4.25"). Omit to use
// the panel's cached latest known Telemt release
// (`telemt_latest_version` in the updates state); a 409
// `no_known_release` is returned if neither is available.
Version *string `json:"version,omitempty"`
}
DispatchTelemtUpdateRequest Body of `POST /api/agents/{id}/telemt/update`. Both fields are optional — an empty body dispatches the panel's cached latest known Telemt release with no downgrade allowance.
type DispatchTelemtUpdateRequestObject ¶
type DispatchTelemtUpdateRequestObject struct {
Id string `json:"id"`
Body *DispatchTelemtUpdateJSONRequestBody
}
type DispatchTelemtUpdateResponse ¶
type DispatchTelemtUpdateResponse struct {
JobId string `json:"job_id"`
}
DispatchTelemtUpdateResponse defines model for DispatchTelemtUpdateResponse.
type DispatchTelemtUpdateResponseObject ¶
type DispatchTelemtUpdateResponseObject interface {
VisitDispatchTelemtUpdateResponse(w http.ResponseWriter) error
}
type EnrollmentTokenList ¶
type EnrollmentTokenList = []EnrollmentTokenListItem
EnrollmentTokenList defines model for EnrollmentTokenList.
type EnrollmentTokenListItem ¶
type EnrollmentTokenListItem struct {
ConsumedAtUnix *int64 `json:"consumed_at_unix,omitempty"`
ExpiresAtUnix int64 `json:"expires_at_unix"`
FleetGroupId string `json:"fleet_group_id"`
// Handle SHA-256 prefix of the raw value, hex-encoded.
Handle *string `json:"handle,omitempty"`
IssuedAtUnix int64 `json:"issued_at_unix"`
// MaskedValue Truncated form of the raw value, ellipsis-suffixed.
MaskedValue *string `json:"masked_value,omitempty"`
PanelUrl string `json:"panel_url"`
RevokedAtUnix *int64 `json:"revoked_at_unix,omitempty"`
Status EnrollmentTokenListItemStatus `json:"status"`
}
EnrollmentTokenListItem Listing-safe view of an enrollment token. The raw `value` is intentionally absent — only the creation response surfaces the bearer secret. Use `handle` (SHA-256 prefix) to revoke.
type EnrollmentTokenListItemStatus ¶
type EnrollmentTokenListItemStatus string
EnrollmentTokenListItemStatus defines model for EnrollmentTokenListItem.Status.
const ( EnrollmentTokenListItemStatusActive EnrollmentTokenListItemStatus = "active" EnrollmentTokenListItemStatusConsumed EnrollmentTokenListItemStatus = "consumed" EnrollmentTokenListItemStatusExpired EnrollmentTokenListItemStatus = "expired" EnrollmentTokenListItemStatusRevoked EnrollmentTokenListItemStatus = "revoked" )
Defines values for EnrollmentTokenListItemStatus.
func (EnrollmentTokenListItemStatus) Valid ¶
func (e EnrollmentTokenListItemStatus) Valid() bool
Valid indicates whether the value is a known member of the EnrollmentTokenListItemStatus enum.
type Error ¶
type Error struct {
// Details Optional structured context. Shape varies per error code.
Details *map[string]interface{} `json:"details,omitempty"`
// Error Machine-readable error code (e.g. `not_found`, `forbidden`).
Error string `json:"error"`
// Message Human-readable message; safe to display to operators.
Message *string `json:"message,omitempty"`
}
Error Standard error envelope used by every 4xx / 5xx response.
type Forbidden ¶
type Forbidden = Error
Forbidden Standard error envelope used by every 4xx / 5xx response.
type ForbiddenJSONResponse ¶
type ForbiddenJSONResponse Error
type GetAgentConfig200JSONResponse ¶
type GetAgentConfig200JSONResponse AgentConfigResponse
func (GetAgentConfig200JSONResponse) VisitGetAgentConfigResponse ¶
func (response GetAgentConfig200JSONResponse) VisitGetAgentConfigResponse(w http.ResponseWriter) error
type GetAgentConfig401JSONResponse ¶
func (GetAgentConfig401JSONResponse) VisitGetAgentConfigResponse ¶
func (response GetAgentConfig401JSONResponse) VisitGetAgentConfigResponse(w http.ResponseWriter) error
type GetAgentConfig403JSONResponse ¶
type GetAgentConfig403JSONResponse struct{ ForbiddenJSONResponse }
func (GetAgentConfig403JSONResponse) VisitGetAgentConfigResponse ¶
func (response GetAgentConfig403JSONResponse) VisitGetAgentConfigResponse(w http.ResponseWriter) error
type GetAgentConfig404JSONResponse ¶
type GetAgentConfig404JSONResponse struct{ NotFoundJSONResponse }
func (GetAgentConfig404JSONResponse) VisitGetAgentConfigResponse ¶
func (response GetAgentConfig404JSONResponse) VisitGetAgentConfigResponse(w http.ResponseWriter) error
type GetAgentConfigRequestObject ¶
type GetAgentConfigRequestObject struct {
Id string `json:"id"`
}
type GetAgentConfigResponseObject ¶
type GetAgentConfigResponseObject interface {
VisitGetAgentConfigResponse(w http.ResponseWriter) error
}
type GetHealthz200TextResponse ¶
type GetHealthz200TextResponse string
func (GetHealthz200TextResponse) VisitGetHealthzResponse ¶
func (response GetHealthz200TextResponse) VisitGetHealthzResponse(w http.ResponseWriter) error
type GetHealthzRequestObject ¶
type GetHealthzRequestObject struct {
}
type GetHealthzResponseObject ¶
type GetHealthzResponseObject interface {
VisitGetHealthzResponse(w http.ResponseWriter) error
}
type GetTelemtUpdateStrategy200JSONResponse ¶
type GetTelemtUpdateStrategy200JSONResponse TelemtUpdateStrategyResponse
func (GetTelemtUpdateStrategy200JSONResponse) VisitGetTelemtUpdateStrategyResponse ¶
func (response GetTelemtUpdateStrategy200JSONResponse) VisitGetTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type GetTelemtUpdateStrategy401JSONResponse ¶
func (GetTelemtUpdateStrategy401JSONResponse) VisitGetTelemtUpdateStrategyResponse ¶
func (response GetTelemtUpdateStrategy401JSONResponse) VisitGetTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type GetTelemtUpdateStrategy403JSONResponse ¶
type GetTelemtUpdateStrategy403JSONResponse struct{ ForbiddenJSONResponse }
func (GetTelemtUpdateStrategy403JSONResponse) VisitGetTelemtUpdateStrategyResponse ¶
func (response GetTelemtUpdateStrategy403JSONResponse) VisitGetTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type GetTelemtUpdateStrategy404JSONResponse ¶
type GetTelemtUpdateStrategy404JSONResponse struct{ NotFoundJSONResponse }
func (GetTelemtUpdateStrategy404JSONResponse) VisitGetTelemtUpdateStrategyResponse ¶
func (response GetTelemtUpdateStrategy404JSONResponse) VisitGetTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type GetTelemtUpdateStrategyRequestObject ¶
type GetTelemtUpdateStrategyRequestObject struct {
Id string `json:"id"`
}
type GetTelemtUpdateStrategyResponseObject ¶
type GetTelemtUpdateStrategyResponseObject interface {
VisitGetTelemtUpdateStrategyResponse(w http.ResponseWriter) error
}
type GetVersion200JSONResponse ¶
type GetVersion200JSONResponse VersionResponse
func (GetVersion200JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion200JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersion401JSONResponse ¶
func (GetVersion401JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion401JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersionRequestObject ¶
type GetVersionRequestObject struct {
}
type GetVersionResponseObject ¶
type GetVersionResponseObject interface {
VisitGetVersionResponse(w http.ResponseWriter) error
}
type InstallCommandAdvancedOptions ¶
type InstallCommandAdvancedOptions struct {
// InsecureTransport Opt-in: allow plain-HTTP panel URLs on non-loopback hosts.
// Intended for VPN-only / private-network deploys where the
// bootstrap-key handshake transits in cleartext.
InsecureTransport *bool `json:"insecure_transport,omitempty"`
// TelemtAuth Authorization header value (e.g. "Bearer xxx") the agent
// forwards to Telemt. Empty / omitted = no auth header.
TelemtAuth *string `json:"telemt_auth,omitempty"`
// TelemtMetricsUrl Override the agent's Telemt metrics URL.
TelemtMetricsUrl *string `json:"telemt_metrics_url,omitempty"`
// TelemtUrl Override the agent's Telemt API URL.
TelemtUrl *string `json:"telemt_url,omitempty"`
}
InstallCommandAdvancedOptions Optional per-install overrides — the wizard's "Advanced" section. All fields nullable / omittable so the default install (with the agent's built-in Telemt defaults) needs none of these.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListAgents200JSONResponse ¶
type ListAgents200JSONResponse AgentList
func (ListAgents200JSONResponse) VisitListAgentsResponse ¶
func (response ListAgents200JSONResponse) VisitListAgentsResponse(w http.ResponseWriter) error
type ListAgents401JSONResponse ¶
func (ListAgents401JSONResponse) VisitListAgentsResponse ¶
func (response ListAgents401JSONResponse) VisitListAgentsResponse(w http.ResponseWriter) error
type ListAgents403JSONResponse ¶
type ListAgents403JSONResponse struct{ ForbiddenJSONResponse }
func (ListAgents403JSONResponse) VisitListAgentsResponse ¶
func (response ListAgents403JSONResponse) VisitListAgentsResponse(w http.ResponseWriter) error
type ListAgentsRequestObject ¶
type ListAgentsRequestObject struct {
}
type ListAgentsResponseObject ¶
type ListAgentsResponseObject interface {
VisitListAgentsResponse(w http.ResponseWriter) error
}
type ListEnrollmentTokens200JSONResponse ¶
type ListEnrollmentTokens200JSONResponse EnrollmentTokenList
func (ListEnrollmentTokens200JSONResponse) VisitListEnrollmentTokensResponse ¶
func (response ListEnrollmentTokens200JSONResponse) VisitListEnrollmentTokensResponse(w http.ResponseWriter) error
type ListEnrollmentTokens401JSONResponse ¶
func (ListEnrollmentTokens401JSONResponse) VisitListEnrollmentTokensResponse ¶
func (response ListEnrollmentTokens401JSONResponse) VisitListEnrollmentTokensResponse(w http.ResponseWriter) error
type ListEnrollmentTokens403JSONResponse ¶
type ListEnrollmentTokens403JSONResponse struct{ ForbiddenJSONResponse }
func (ListEnrollmentTokens403JSONResponse) VisitListEnrollmentTokensResponse ¶
func (response ListEnrollmentTokens403JSONResponse) VisitListEnrollmentTokensResponse(w http.ResponseWriter) error
type ListEnrollmentTokensRequestObject ¶
type ListEnrollmentTokensRequestObject struct {
}
type ListEnrollmentTokensResponseObject ¶
type ListEnrollmentTokensResponseObject interface {
VisitListEnrollmentTokensResponse(w http.ResponseWriter) error
}
type NotFound ¶
type NotFound = Error
NotFound Standard error envelope used by every 4xx / 5xx response.
type NotFoundJSONResponse ¶
type NotFoundJSONResponse Error
type ProvisionOutboundAgent201JSONResponse ¶
type ProvisionOutboundAgent201JSONResponse ProvisionOutboundAgentResponse
func (ProvisionOutboundAgent201JSONResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent201JSONResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgent400JSONResponse ¶
type ProvisionOutboundAgent400JSONResponse struct{ BadRequestJSONResponse }
func (ProvisionOutboundAgent400JSONResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent400JSONResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgent401JSONResponse ¶
func (ProvisionOutboundAgent401JSONResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent401JSONResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgent403JSONResponse ¶
type ProvisionOutboundAgent403JSONResponse struct{ ForbiddenJSONResponse }
func (ProvisionOutboundAgent403JSONResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent403JSONResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgent409JSONResponse ¶
type ProvisionOutboundAgent409JSONResponse Error
func (ProvisionOutboundAgent409JSONResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent409JSONResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgent503TextResponse ¶
type ProvisionOutboundAgent503TextResponse string
func (ProvisionOutboundAgent503TextResponse) VisitProvisionOutboundAgentResponse ¶
func (response ProvisionOutboundAgent503TextResponse) VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
type ProvisionOutboundAgentJSONRequestBody ¶
type ProvisionOutboundAgentJSONRequestBody = ProvisionOutboundAgentRequest
ProvisionOutboundAgentJSONRequestBody defines body for ProvisionOutboundAgent for application/json ContentType.
type ProvisionOutboundAgentRequest ¶
type ProvisionOutboundAgentRequest struct {
// Advanced Optional per-install overrides — the wizard's "Advanced" section.
// All fields nullable / omittable so the default install (with the
// agent's built-in Telemt defaults) needs none of these.
Advanced *InstallCommandAdvancedOptions `json:"advanced,omitempty"`
// DialAddress Public host:port the panel dials to reach the agent. Used
// both for the agent's listen bind (derived port) and for
// the panel's outbound supervisor target.
DialAddress string `json:"dial_address"`
// FleetGroupId Canonical fleet-group UUID or friendly slug. Empty string
// falls back to the operator's default fleet group.
FleetGroupId string `json:"fleet_group_id"`
// NodeName Operator-supplied display name. Must satisfy the same
// character class enforced for inbound enrollment
// (`[A-Za-z0-9._-]+`), since the value is interpolated into
// the curl|bash one-liner as a CLI flag value.
NodeName string `json:"node_name"`
// ScriptSource Source from which the agent host fetches install-agent.sh.
// 'github' is the default for outbound because the panel is
// typically firewalled from the agent host (otherwise the
// operator would use inbound mode); 'panel' is supported for
// cases where the agent can reach the panel during bootstrap
// even though the steady-state transport is reverse.
ScriptSource *ProvisionOutboundAgentRequestScriptSource `json:"script_source,omitempty"`
}
ProvisionOutboundAgentRequest defines model for ProvisionOutboundAgentRequest.
type ProvisionOutboundAgentRequestObject ¶
type ProvisionOutboundAgentRequestObject struct {
Body *ProvisionOutboundAgentJSONRequestBody
}
type ProvisionOutboundAgentRequestScriptSource ¶
type ProvisionOutboundAgentRequestScriptSource string
ProvisionOutboundAgentRequestScriptSource Source from which the agent host fetches install-agent.sh. 'github' is the default for outbound because the panel is typically firewalled from the agent host (otherwise the operator would use inbound mode); 'panel' is supported for cases where the agent can reach the panel during bootstrap even though the steady-state transport is reverse.
const ( Github ProvisionOutboundAgentRequestScriptSource = "github" Panel ProvisionOutboundAgentRequestScriptSource = "panel" )
Defines values for ProvisionOutboundAgentRequestScriptSource.
func (ProvisionOutboundAgentRequestScriptSource) Valid ¶
func (e ProvisionOutboundAgentRequestScriptSource) Valid() bool
Valid indicates whether the value is a known member of the ProvisionOutboundAgentRequestScriptSource enum.
type ProvisionOutboundAgentResponse ¶
type ProvisionOutboundAgentResponse struct {
AgentId string `json:"agent_id"`
// Command Pre-baked `curl ... | sudo bash -s -- ...` one-liner.
Command string `json:"command"`
ExpiresAtUnix int64 `json:"expires_at_unix"`
// ScriptUrl The URL the curl in the command points at — exposed so the
// wizard can show the operator which source was used.
ScriptUrl string `json:"script_url"`
}
ProvisionOutboundAgentResponse Returned by `POST /api/agents/provision-outbound`: the install one-liner and its expiry, plus the freshly-minted agent_id so the wizard can poll `GET /api/agents/{id}` for the first connection and call `DELETE /api/agents/{id}` on cancel.
type ProvisionOutboundAgentResponseObject ¶
type ProvisionOutboundAgentResponseObject interface {
VisitProvisionOutboundAgentResponse(w http.ResponseWriter) error
}
type PutTelemtUpdateStrategy204Response ¶
type PutTelemtUpdateStrategy204Response struct {
}
func (PutTelemtUpdateStrategy204Response) VisitPutTelemtUpdateStrategyResponse ¶
func (response PutTelemtUpdateStrategy204Response) VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type PutTelemtUpdateStrategy400JSONResponse ¶
type PutTelemtUpdateStrategy400JSONResponse struct{ BadRequestJSONResponse }
func (PutTelemtUpdateStrategy400JSONResponse) VisitPutTelemtUpdateStrategyResponse ¶
func (response PutTelemtUpdateStrategy400JSONResponse) VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type PutTelemtUpdateStrategy401JSONResponse ¶
func (PutTelemtUpdateStrategy401JSONResponse) VisitPutTelemtUpdateStrategyResponse ¶
func (response PutTelemtUpdateStrategy401JSONResponse) VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type PutTelemtUpdateStrategy403JSONResponse ¶
type PutTelemtUpdateStrategy403JSONResponse struct{ ForbiddenJSONResponse }
func (PutTelemtUpdateStrategy403JSONResponse) VisitPutTelemtUpdateStrategyResponse ¶
func (response PutTelemtUpdateStrategy403JSONResponse) VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type PutTelemtUpdateStrategy404JSONResponse ¶
type PutTelemtUpdateStrategy404JSONResponse struct{ NotFoundJSONResponse }
func (PutTelemtUpdateStrategy404JSONResponse) VisitPutTelemtUpdateStrategyResponse ¶
func (response PutTelemtUpdateStrategy404JSONResponse) VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
type PutTelemtUpdateStrategyJSONRequestBody ¶
type PutTelemtUpdateStrategyJSONRequestBody = TelemtUpdateStrategy
PutTelemtUpdateStrategyJSONRequestBody defines body for PutTelemtUpdateStrategy for application/json ContentType.
type PutTelemtUpdateStrategyRequestObject ¶
type PutTelemtUpdateStrategyRequestObject struct {
Id string `json:"id"`
Body *PutTelemtUpdateStrategyJSONRequestBody
}
type PutTelemtUpdateStrategyResponseObject ¶
type PutTelemtUpdateStrategyResponseObject interface {
VisitPutTelemtUpdateStrategyResponse(w http.ResponseWriter) error
}
type RenameAgent200JSONResponse ¶
type RenameAgent200JSONResponse Agent
func (RenameAgent200JSONResponse) VisitRenameAgentResponse ¶
func (response RenameAgent200JSONResponse) VisitRenameAgentResponse(w http.ResponseWriter) error
type RenameAgent400JSONResponse ¶
type RenameAgent400JSONResponse struct{ BadRequestJSONResponse }
func (RenameAgent400JSONResponse) VisitRenameAgentResponse ¶
func (response RenameAgent400JSONResponse) VisitRenameAgentResponse(w http.ResponseWriter) error
type RenameAgent401JSONResponse ¶
func (RenameAgent401JSONResponse) VisitRenameAgentResponse ¶
func (response RenameAgent401JSONResponse) VisitRenameAgentResponse(w http.ResponseWriter) error
type RenameAgent404JSONResponse ¶
type RenameAgent404JSONResponse struct{ NotFoundJSONResponse }
func (RenameAgent404JSONResponse) VisitRenameAgentResponse ¶
func (response RenameAgent404JSONResponse) VisitRenameAgentResponse(w http.ResponseWriter) error
type RenameAgentJSONRequestBody ¶
type RenameAgentJSONRequestBody = RenameAgentRequest
RenameAgentJSONRequestBody defines body for RenameAgent for application/json ContentType.
type RenameAgentRequest ¶
type RenameAgentRequest struct {
NodeName string `json:"node_name"`
}
RenameAgentRequest defines model for RenameAgentRequest.
type RenameAgentRequestObject ¶
type RenameAgentRequestObject struct {
Id string `json:"id"`
Body *RenameAgentJSONRequestBody
}
type RenameAgentResponseObject ¶
type RenameAgentResponseObject interface {
VisitRenameAgentResponse(w http.ResponseWriter) error
}
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type RevokeAgentCertificateRecoveryGrant200JSONResponse ¶
type RevokeAgentCertificateRecoveryGrant200JSONResponse AgentCertificateRecoveryGrant
func (RevokeAgentCertificateRecoveryGrant200JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse ¶
func (response RevokeAgentCertificateRecoveryGrant200JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type RevokeAgentCertificateRecoveryGrant401JSONResponse ¶
func (RevokeAgentCertificateRecoveryGrant401JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse ¶
func (response RevokeAgentCertificateRecoveryGrant401JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type RevokeAgentCertificateRecoveryGrant403JSONResponse ¶
type RevokeAgentCertificateRecoveryGrant403JSONResponse struct{ ForbiddenJSONResponse }
func (RevokeAgentCertificateRecoveryGrant403JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse ¶
func (response RevokeAgentCertificateRecoveryGrant403JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type RevokeAgentCertificateRecoveryGrant404JSONResponse ¶
type RevokeAgentCertificateRecoveryGrant404JSONResponse struct{ NotFoundJSONResponse }
func (RevokeAgentCertificateRecoveryGrant404JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse ¶
func (response RevokeAgentCertificateRecoveryGrant404JSONResponse) VisitRevokeAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
type RevokeAgentCertificateRecoveryGrantRequestObject ¶
type RevokeAgentCertificateRecoveryGrantRequestObject struct {
Id string `json:"id"`
}
type RevokeAgentCertificateRecoveryGrantResponseObject ¶
type RevokeAgentCertificateRecoveryGrantResponseObject interface {
VisitRevokeAgentCertificateRecoveryGrantResponse(w http.ResponseWriter) error
}
type RevokeEnrollmentToken204Response ¶
type RevokeEnrollmentToken204Response struct {
}
func (RevokeEnrollmentToken204Response) VisitRevokeEnrollmentTokenResponse ¶
func (response RevokeEnrollmentToken204Response) VisitRevokeEnrollmentTokenResponse(w http.ResponseWriter) error
type RevokeEnrollmentToken401JSONResponse ¶
func (RevokeEnrollmentToken401JSONResponse) VisitRevokeEnrollmentTokenResponse ¶
func (response RevokeEnrollmentToken401JSONResponse) VisitRevokeEnrollmentTokenResponse(w http.ResponseWriter) error
type RevokeEnrollmentToken403JSONResponse ¶
type RevokeEnrollmentToken403JSONResponse struct{ ForbiddenJSONResponse }
func (RevokeEnrollmentToken403JSONResponse) VisitRevokeEnrollmentTokenResponse ¶
func (response RevokeEnrollmentToken403JSONResponse) VisitRevokeEnrollmentTokenResponse(w http.ResponseWriter) error
type RevokeEnrollmentToken404JSONResponse ¶
type RevokeEnrollmentToken404JSONResponse struct{ NotFoundJSONResponse }
func (RevokeEnrollmentToken404JSONResponse) VisitRevokeEnrollmentTokenResponse ¶
func (response RevokeEnrollmentToken404JSONResponse) VisitRevokeEnrollmentTokenResponse(w http.ResponseWriter) error
type RevokeEnrollmentTokenRequestObject ¶
type RevokeEnrollmentTokenRequestObject struct {
Value string `json:"value"`
}
type RevokeEnrollmentTokenResponseObject ¶
type RevokeEnrollmentTokenResponseObject interface {
VisitRevokeEnrollmentTokenResponse(w http.ResponseWriter) error
}
type RuntimeDC ¶
type RuntimeDC struct {
AliveWriters int `json:"alive_writers"`
AvailableEndpoints int `json:"available_endpoints"`
AvailablePct float64 `json:"available_pct"`
CoveragePct float64 `json:"coverage_pct"`
Dc int `json:"dc"`
FreshAliveWriters int `json:"fresh_alive_writers"`
FreshCoveragePct float64 `json:"fresh_coverage_pct"`
Load int `json:"load"`
RequiredWriters int `json:"required_writers"`
RttMs float64 `json:"rtt_ms"`
}
RuntimeDC defines model for RuntimeDC.
type RuntimeEvent ¶
type RuntimeEvent struct {
Context string `json:"context"`
EventType string `json:"event_type"`
Sequence int64 `json:"sequence"`
TimestampUnix int64 `json:"timestamp_unix"`
}
RuntimeEvent defines model for RuntimeEvent.
type RuntimeMeWritersSummary ¶
type RuntimeMeWritersSummary struct {
AliveWriters int `json:"alive_writers"`
AvailableEndpoints int `json:"available_endpoints"`
ConfiguredEndpoints int `json:"configured_endpoints"`
CoveragePct float64 `json:"coverage_pct"`
FreshAliveWriters int `json:"fresh_alive_writers"`
FreshCoveragePct float64 `json:"fresh_coverage_pct"`
RequiredWriters int `json:"required_writers"`
}
RuntimeMeWritersSummary defines model for RuntimeMeWritersSummary.
type RuntimeSystemLoad ¶
type RuntimeSystemLoad struct {
CpuUsagePct float64 `json:"cpu_usage_pct"`
DiskTotalBytes int64 `json:"disk_total_bytes"`
DiskUsagePct float64 `json:"disk_usage_pct"`
DiskUsedBytes int64 `json:"disk_used_bytes"`
Load15m float64 `json:"load_15m"`
Load1m float64 `json:"load_1m"`
Load5m float64 `json:"load_5m"`
MemoryTotalBytes int64 `json:"memory_total_bytes"`
MemoryUsagePct float64 `json:"memory_usage_pct"`
MemoryUsedBytes int64 `json:"memory_used_bytes"`
NetBytesRecv int64 `json:"net_bytes_recv"`
NetBytesSent int64 `json:"net_bytes_sent"`
}
RuntimeSystemLoad defines model for RuntimeSystemLoad.
type RuntimeTopByConnections ¶
type RuntimeTopByConnections struct {
Connections int `json:"connections"`
Username string `json:"username"`
}
RuntimeTopByConnections defines model for RuntimeTopByConnections.
type RuntimeTopByThroughput ¶
type RuntimeTopByThroughput struct {
ThroughputBytes int64 `json:"throughput_bytes"`
Username string `json:"username"`
}
RuntimeTopByThroughput defines model for RuntimeTopByThroughput.
type RuntimeUpstream ¶
type RuntimeUpstream struct {
Address string `json:"address"`
EffectiveLatencyMs float64 `json:"effective_latency_ms"`
Fails int `json:"fails"`
Healthy bool `json:"healthy"`
LastCheckAgeSecs int `json:"last_check_age_secs"`
RouteKind string `json:"route_kind"`
Scopes *[]string `json:"scopes,omitempty"`
UpstreamId int `json:"upstream_id"`
Weight int `json:"weight"`
}
RuntimeUpstream defines model for RuntimeUpstream.
type ScriptSource ¶
type ScriptSource struct {
// Sha256 Lowercase hex SHA-256 of the script body. Populated for the
// Panel-served source (the panel knows the exact bytes it is
// serving); null for the GitHub-hosted fallback (no
// panel-side integrity guarantee — operators pin a release
// tag instead).
Sha256 *string `json:"sha256,omitempty"`
// Url Fully-qualified HTTPS URL to install-agent.sh.
Url string `json:"url"`
}
ScriptSource Pointer to a hosted copy of the agent install script (`install-agent.sh`). Each source carries its own URL; the Panel-served copy also exports its SHA-256 so the operator client can render a tamper-resistant curl|sudo-bash form.
type ScriptSources ¶
type ScriptSources struct {
// Github Pointer to a hosted copy of the agent install script
// (`install-agent.sh`). Each source carries its own URL; the
// Panel-served copy also exports its SHA-256 so the operator
// client can render a tamper-resistant curl|sudo-bash form.
Github ScriptSource `json:"github"`
// Panel Pointer to a hosted copy of the agent install script
// (`install-agent.sh`). Each source carries its own URL; the
// Panel-served copy also exports its SHA-256 so the operator
// client can render a tamper-resistant curl|sudo-bash form.
Panel ScriptSource `json:"panel"`
}
ScriptSources The two canonical sources from which an agent host can fetch the install script. Operators choose between them in the Add-Server wizard — Panel for the default inbound case (panel is reachable, integrity-checked), GitHub for outbound (panel is firewalled from the agent host) or cold-bootstrap.
type SelfUpdateState ¶
type SelfUpdateState struct {
FromVersion *string `json:"from_version,omitempty"`
Message *string `json:"message,omitempty"`
Phase SelfUpdateStatePhase `json:"phase"`
ToVersion *string `json:"to_version,omitempty"`
// UpdatedAt Unix seconds of the last phase transition.
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
SelfUpdateState Server-side lifecycle of the current or most-recent panel self-update run, persisted across restarts. `phase` is the source of truth for whether an update is in progress: the empty string means idle (no run started, or nothing to show). `completed` and `failed` are terminal; on `failed`, `message` carries the operator-readable reason. The dashboard reads this so an in-flight update survives a page reload and always resolves to a terminal outcome.
type SelfUpdateStatePhase ¶
type SelfUpdateStatePhase string
SelfUpdateStatePhase defines model for SelfUpdateState.Phase.
const ( Completed SelfUpdateStatePhase = "completed" Downloading SelfUpdateStatePhase = "downloading" Empty SelfUpdateStatePhase = "" Failed SelfUpdateStatePhase = "failed" Installing SelfUpdateStatePhase = "installing" RestartPending SelfUpdateStatePhase = "restart_pending" )
Defines values for SelfUpdateStatePhase.
func (SelfUpdateStatePhase) Valid ¶
func (e SelfUpdateStatePhase) Valid() bool
Valid indicates whether the value is a known member of the SelfUpdateStatePhase enum.
type ServerInterface ¶
type ServerInterface interface {
// List enrolled agents in operator's fleet scope
// (GET /api/agents)
ListAgents(w http.ResponseWriter, r *http.Request)
// List enrollment tokens visible to the operator
// (GET /api/agents/enrollment-tokens)
ListEnrollmentTokens(w http.ResponseWriter, r *http.Request)
// Mint a new enrollment token
// (POST /api/agents/enrollment-tokens)
CreateEnrollmentToken(w http.ResponseWriter, r *http.Request)
// Revoke an enrollment token
// (POST /api/agents/enrollment-tokens/{value}/revoke)
RevokeEnrollmentToken(w http.ResponseWriter, r *http.Request, value string)
// Create an outbound agent and return its install command
// (POST /api/agents/provision-outbound)
ProvisionOutboundAgent(w http.ResponseWriter, r *http.Request)
// Deregister an agent
// (DELETE /api/agents/{id})
DeregisterAgent(w http.ResponseWriter, r *http.Request, id string)
// Rename an agent's display node-name
// (PATCH /api/agents/{id})
RenameAgent(w http.ResponseWriter, r *http.Request, id string)
// Allow an agent to recover an expired certificate
// (POST /api/agents/{id}/certificate-recovery-grants)
CreateAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
// Revoke a previously-issued recovery grant
// (POST /api/agents/{id}/certificate-recovery-grants/revoke)
RevokeAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
// Get an agent's desired config snapshot, effective merge, observed config, and drift
// (GET /api/agents/{id}/config)
GetAgentConfig(w http.ResponseWriter, r *http.Request, id string)
// Apply the effective config target to a single agent
// (POST /api/agents/{id}/config/apply)
ApplyAgentConfig(w http.ResponseWriter, r *http.Request, id string)
// Reassign an agent to a different fleet group
// (PUT /api/agents/{id}/fleet-group)
UpdateAgentFleetGroup(w http.ResponseWriter, r *http.Request, id string)
// Enqueue a telemt.update job for an agent's managed Telemt install
// (POST /api/agents/{id}/telemt/update)
DispatchTelemtUpdate(w http.ResponseWriter, r *http.Request, id string)
// Get an agent's Telemt update strategy and live probe
// (GET /api/agents/{id}/telemt/update-strategy)
GetTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
// Set an agent's Telemt update strategy
// (PUT /api/agents/{id}/telemt/update-strategy)
PutTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
// Switch an agent between inbound and outbound transport
// (PUT /api/agents/{id}/transport-mode)
UpdateAgentTransportMode(w http.ResponseWriter, r *http.Request, id string)
// Enqueue a self-update job for an agent
// (POST /api/agents/{id}/update)
DispatchAgentUpdate(w http.ResponseWriter, r *http.Request, id string)
// Apply the effective config target to every in-scope agent in a fleet group
// (POST /api/fleet-groups/{id}/config/apply)
ApplyGroupConfig(w http.ResponseWriter, r *http.Request, id string)
// Panel build identification
// (GET /api/version)
GetVersion(w http.ResponseWriter, r *http.Request)
// Liveness probe
// (GET /healthz)
GetHealthz(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
func NewStrictHandlerWithOptions ¶
func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) ApplyAgentConfig ¶
func (siw *ServerInterfaceWrapper) ApplyAgentConfig(w http.ResponseWriter, r *http.Request)
ApplyAgentConfig operation middleware
func (*ServerInterfaceWrapper) ApplyGroupConfig ¶
func (siw *ServerInterfaceWrapper) ApplyGroupConfig(w http.ResponseWriter, r *http.Request)
ApplyGroupConfig operation middleware
func (*ServerInterfaceWrapper) CreateAgentCertificateRecoveryGrant ¶
func (siw *ServerInterfaceWrapper) CreateAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request)
CreateAgentCertificateRecoveryGrant operation middleware
func (*ServerInterfaceWrapper) CreateEnrollmentToken ¶
func (siw *ServerInterfaceWrapper) CreateEnrollmentToken(w http.ResponseWriter, r *http.Request)
CreateEnrollmentToken operation middleware
func (*ServerInterfaceWrapper) DeregisterAgent ¶
func (siw *ServerInterfaceWrapper) DeregisterAgent(w http.ResponseWriter, r *http.Request)
DeregisterAgent operation middleware
func (*ServerInterfaceWrapper) DispatchAgentUpdate ¶
func (siw *ServerInterfaceWrapper) DispatchAgentUpdate(w http.ResponseWriter, r *http.Request)
DispatchAgentUpdate operation middleware
func (*ServerInterfaceWrapper) DispatchTelemtUpdate ¶
func (siw *ServerInterfaceWrapper) DispatchTelemtUpdate(w http.ResponseWriter, r *http.Request)
DispatchTelemtUpdate operation middleware
func (*ServerInterfaceWrapper) GetAgentConfig ¶
func (siw *ServerInterfaceWrapper) GetAgentConfig(w http.ResponseWriter, r *http.Request)
GetAgentConfig operation middleware
func (*ServerInterfaceWrapper) GetHealthz ¶
func (siw *ServerInterfaceWrapper) GetHealthz(w http.ResponseWriter, r *http.Request)
GetHealthz operation middleware
func (*ServerInterfaceWrapper) GetTelemtUpdateStrategy ¶
func (siw *ServerInterfaceWrapper) GetTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request)
GetTelemtUpdateStrategy operation middleware
func (*ServerInterfaceWrapper) GetVersion ¶
func (siw *ServerInterfaceWrapper) GetVersion(w http.ResponseWriter, r *http.Request)
GetVersion operation middleware
func (*ServerInterfaceWrapper) ListAgents ¶
func (siw *ServerInterfaceWrapper) ListAgents(w http.ResponseWriter, r *http.Request)
ListAgents operation middleware
func (*ServerInterfaceWrapper) ListEnrollmentTokens ¶
func (siw *ServerInterfaceWrapper) ListEnrollmentTokens(w http.ResponseWriter, r *http.Request)
ListEnrollmentTokens operation middleware
func (*ServerInterfaceWrapper) ProvisionOutboundAgent ¶
func (siw *ServerInterfaceWrapper) ProvisionOutboundAgent(w http.ResponseWriter, r *http.Request)
ProvisionOutboundAgent operation middleware
func (*ServerInterfaceWrapper) PutTelemtUpdateStrategy ¶
func (siw *ServerInterfaceWrapper) PutTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request)
PutTelemtUpdateStrategy operation middleware
func (*ServerInterfaceWrapper) RenameAgent ¶
func (siw *ServerInterfaceWrapper) RenameAgent(w http.ResponseWriter, r *http.Request)
RenameAgent operation middleware
func (*ServerInterfaceWrapper) RevokeAgentCertificateRecoveryGrant ¶
func (siw *ServerInterfaceWrapper) RevokeAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request)
RevokeAgentCertificateRecoveryGrant operation middleware
func (*ServerInterfaceWrapper) RevokeEnrollmentToken ¶
func (siw *ServerInterfaceWrapper) RevokeEnrollmentToken(w http.ResponseWriter, r *http.Request)
RevokeEnrollmentToken operation middleware
func (*ServerInterfaceWrapper) UpdateAgentFleetGroup ¶
func (siw *ServerInterfaceWrapper) UpdateAgentFleetGroup(w http.ResponseWriter, r *http.Request)
UpdateAgentFleetGroup operation middleware
func (*ServerInterfaceWrapper) UpdateAgentTransportMode ¶
func (siw *ServerInterfaceWrapper) UpdateAgentTransportMode(w http.ResponseWriter, r *http.Request)
UpdateAgentTransportMode operation middleware
type StrictHTTPServerOptions ¶
type StrictHTTPServerOptions struct {
RequestErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type StrictHandlerFunc ¶
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// List enrolled agents in operator's fleet scope
// (GET /api/agents)
ListAgents(ctx context.Context, request ListAgentsRequestObject) (ListAgentsResponseObject, error)
// List enrollment tokens visible to the operator
// (GET /api/agents/enrollment-tokens)
ListEnrollmentTokens(ctx context.Context, request ListEnrollmentTokensRequestObject) (ListEnrollmentTokensResponseObject, error)
// Mint a new enrollment token
// (POST /api/agents/enrollment-tokens)
CreateEnrollmentToken(ctx context.Context, request CreateEnrollmentTokenRequestObject) (CreateEnrollmentTokenResponseObject, error)
// Revoke an enrollment token
// (POST /api/agents/enrollment-tokens/{value}/revoke)
RevokeEnrollmentToken(ctx context.Context, request RevokeEnrollmentTokenRequestObject) (RevokeEnrollmentTokenResponseObject, error)
// Create an outbound agent and return its install command
// (POST /api/agents/provision-outbound)
ProvisionOutboundAgent(ctx context.Context, request ProvisionOutboundAgentRequestObject) (ProvisionOutboundAgentResponseObject, error)
// Deregister an agent
// (DELETE /api/agents/{id})
DeregisterAgent(ctx context.Context, request DeregisterAgentRequestObject) (DeregisterAgentResponseObject, error)
// Rename an agent's display node-name
// (PATCH /api/agents/{id})
RenameAgent(ctx context.Context, request RenameAgentRequestObject) (RenameAgentResponseObject, error)
// Allow an agent to recover an expired certificate
// (POST /api/agents/{id}/certificate-recovery-grants)
CreateAgentCertificateRecoveryGrant(ctx context.Context, request CreateAgentCertificateRecoveryGrantRequestObject) (CreateAgentCertificateRecoveryGrantResponseObject, error)
// Revoke a previously-issued recovery grant
// (POST /api/agents/{id}/certificate-recovery-grants/revoke)
RevokeAgentCertificateRecoveryGrant(ctx context.Context, request RevokeAgentCertificateRecoveryGrantRequestObject) (RevokeAgentCertificateRecoveryGrantResponseObject, error)
// Get an agent's desired config snapshot, effective merge, observed config, and drift
// (GET /api/agents/{id}/config)
GetAgentConfig(ctx context.Context, request GetAgentConfigRequestObject) (GetAgentConfigResponseObject, error)
// Apply the effective config target to a single agent
// (POST /api/agents/{id}/config/apply)
ApplyAgentConfig(ctx context.Context, request ApplyAgentConfigRequestObject) (ApplyAgentConfigResponseObject, error)
// Reassign an agent to a different fleet group
// (PUT /api/agents/{id}/fleet-group)
UpdateAgentFleetGroup(ctx context.Context, request UpdateAgentFleetGroupRequestObject) (UpdateAgentFleetGroupResponseObject, error)
// Enqueue a telemt.update job for an agent's managed Telemt install
// (POST /api/agents/{id}/telemt/update)
DispatchTelemtUpdate(ctx context.Context, request DispatchTelemtUpdateRequestObject) (DispatchTelemtUpdateResponseObject, error)
// Get an agent's Telemt update strategy and live probe
// (GET /api/agents/{id}/telemt/update-strategy)
GetTelemtUpdateStrategy(ctx context.Context, request GetTelemtUpdateStrategyRequestObject) (GetTelemtUpdateStrategyResponseObject, error)
// Set an agent's Telemt update strategy
// (PUT /api/agents/{id}/telemt/update-strategy)
PutTelemtUpdateStrategy(ctx context.Context, request PutTelemtUpdateStrategyRequestObject) (PutTelemtUpdateStrategyResponseObject, error)
// Switch an agent between inbound and outbound transport
// (PUT /api/agents/{id}/transport-mode)
UpdateAgentTransportMode(ctx context.Context, request UpdateAgentTransportModeRequestObject) (UpdateAgentTransportModeResponseObject, error)
// Enqueue a self-update job for an agent
// (POST /api/agents/{id}/update)
DispatchAgentUpdate(ctx context.Context, request DispatchAgentUpdateRequestObject) (DispatchAgentUpdateResponseObject, error)
// Apply the effective config target to every in-scope agent in a fleet group
// (POST /api/fleet-groups/{id}/config/apply)
ApplyGroupConfig(ctx context.Context, request ApplyGroupConfigRequestObject) (ApplyGroupConfigResponseObject, error)
// Panel build identification
// (GET /api/version)
GetVersion(ctx context.Context, request GetVersionRequestObject) (GetVersionResponseObject, error)
// Liveness probe
// (GET /healthz)
GetHealthz(ctx context.Context, request GetHealthzRequestObject) (GetHealthzResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TelemtUpdateProbe ¶
type TelemtUpdateProbe struct {
// Available Whether an in-place update is offered at all.
Available bool `json:"available"`
// BinaryPath Best-effort resolved path to the telemt executable, used as
// the swap target. May be empty if it could not be resolved.
BinaryPath string `json:"binary_path"`
// Mode "binary" (a supported supervisor owns telemt; a binary swap +
// supervised restart is safe), "docker" (telemt runs in a
// container; updates must go through the image), or "none"
// (nothing detected).
Mode string `json:"mode"`
// Reason Localizable CODE (not a human-readable phrase) explaining why
// available is false, e.g. "docker_only",
// "no_service_manager_detected". Empty when available is true.
Reason string `json:"reason"`
// SuggestedRestartSpec telemtrestart spec ("systemd:telemt", "openrc:telemt",
// "procd:telemt", "runit:telemt") to use for the supervised
// restart after a binary swap. Empty when mode != "binary".
SuggestedRestartSpec string `json:"suggested_restart_spec"`
}
TelemtUpdateProbe Result of the agent probing its local process supervisor (systemd, OpenRC/procd, runit, docker, or none) once at startup, used by the panel to decide whether an in-place telemt update is safe to offer for this node.
type TelemtUpdateStrategy ¶
type TelemtUpdateStrategy struct {
// AssetFlavor Release-asset variant to download for this agent, e.g. "v3"
// for a CPU-feature-optimised build. Empty selects the default
// asset.
AssetFlavor string `json:"asset_flavor"`
// BinaryPath Absolute path to the telemt executable, used as the swap
// target. Required for mode=binary.
BinaryPath string `json:"binary_path"`
// Mode "binary" (a supported supervisor owns telemt; a binary swap +
// supervised restart is safe), "docker" (telemt runs in a
// container; updates must go through the image), or "none" (no
// in-place update path).
Mode TelemtUpdateStrategyMode `json:"mode"`
// RestartSpec telemtrestart spec ("systemd:telemt", "openrc:telemt",
// "procd:telemt", "runit:telemt", "command:...") to use for the
// supervised restart after a binary swap. Required for
// mode=binary; validated with the same rules the agent applies.
RestartSpec string `json:"restart_spec"`
}
TelemtUpdateStrategy Operator-configured strategy for how `telemt.update` jobs apply on one agent. Persisted; distinct from TelemtUpdateProbe, which is the agent's own live-detected capability. `restart_spec` and `binary_path` are only meaningful (and required) for `mode: binary`.
type TelemtUpdateStrategyMode ¶
type TelemtUpdateStrategyMode string
TelemtUpdateStrategyMode "binary" (a supported supervisor owns telemt; a binary swap + supervised restart is safe), "docker" (telemt runs in a container; updates must go through the image), or "none" (no in-place update path).
const ( Binary TelemtUpdateStrategyMode = "binary" Docker TelemtUpdateStrategyMode = "docker" None TelemtUpdateStrategyMode = "none" )
Defines values for TelemtUpdateStrategyMode.
func (TelemtUpdateStrategyMode) Valid ¶
func (e TelemtUpdateStrategyMode) Valid() bool
Valid indicates whether the value is a known member of the TelemtUpdateStrategyMode enum.
type TelemtUpdateStrategyResponse ¶
type TelemtUpdateStrategyResponse struct {
Probe *TelemtUpdateProbe `json:"probe"`
Strategy *TelemtUpdateStrategy `json:"strategy"`
}
TelemtUpdateStrategyResponse Response of `GET /api/agents/{id}/telemt/update-strategy`: the persisted strategy (absent when never configured) alongside the agent's live probe (absent until the agent has reported one).
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type Unauthorized ¶
type Unauthorized = Error
Unauthorized Standard error envelope used by every 4xx / 5xx response.
type UnauthorizedJSONResponse ¶
type UnauthorizedJSONResponse Error
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) ApplyAgentConfig ¶
func (_ Unimplemented) ApplyAgentConfig(w http.ResponseWriter, r *http.Request, id string)
Apply the effective config target to a single agent (POST /api/agents/{id}/config/apply)
func (Unimplemented) ApplyGroupConfig ¶
func (_ Unimplemented) ApplyGroupConfig(w http.ResponseWriter, r *http.Request, id string)
Apply the effective config target to every in-scope agent in a fleet group (POST /api/fleet-groups/{id}/config/apply)
func (Unimplemented) CreateAgentCertificateRecoveryGrant ¶
func (_ Unimplemented) CreateAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
Allow an agent to recover an expired certificate (POST /api/agents/{id}/certificate-recovery-grants)
func (Unimplemented) CreateEnrollmentToken ¶
func (_ Unimplemented) CreateEnrollmentToken(w http.ResponseWriter, r *http.Request)
Mint a new enrollment token (POST /api/agents/enrollment-tokens)
func (Unimplemented) DeregisterAgent ¶
func (_ Unimplemented) DeregisterAgent(w http.ResponseWriter, r *http.Request, id string)
Deregister an agent (DELETE /api/agents/{id})
func (Unimplemented) DispatchAgentUpdate ¶
func (_ Unimplemented) DispatchAgentUpdate(w http.ResponseWriter, r *http.Request, id string)
Enqueue a self-update job for an agent (POST /api/agents/{id}/update)
func (Unimplemented) DispatchTelemtUpdate ¶
func (_ Unimplemented) DispatchTelemtUpdate(w http.ResponseWriter, r *http.Request, id string)
Enqueue a telemt.update job for an agent's managed Telemt install (POST /api/agents/{id}/telemt/update)
func (Unimplemented) GetAgentConfig ¶
func (_ Unimplemented) GetAgentConfig(w http.ResponseWriter, r *http.Request, id string)
Get an agent's desired config snapshot, effective merge, observed config, and drift (GET /api/agents/{id}/config)
func (Unimplemented) GetHealthz ¶
func (_ Unimplemented) GetHealthz(w http.ResponseWriter, r *http.Request)
Liveness probe (GET /healthz)
func (Unimplemented) GetTelemtUpdateStrategy ¶
func (_ Unimplemented) GetTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
Get an agent's Telemt update strategy and live probe (GET /api/agents/{id}/telemt/update-strategy)
func (Unimplemented) GetVersion ¶
func (_ Unimplemented) GetVersion(w http.ResponseWriter, r *http.Request)
Panel build identification (GET /api/version)
func (Unimplemented) ListAgents ¶
func (_ Unimplemented) ListAgents(w http.ResponseWriter, r *http.Request)
List enrolled agents in operator's fleet scope (GET /api/agents)
func (Unimplemented) ListEnrollmentTokens ¶
func (_ Unimplemented) ListEnrollmentTokens(w http.ResponseWriter, r *http.Request)
List enrollment tokens visible to the operator (GET /api/agents/enrollment-tokens)
func (Unimplemented) ProvisionOutboundAgent ¶
func (_ Unimplemented) ProvisionOutboundAgent(w http.ResponseWriter, r *http.Request)
Create an outbound agent and return its install command (POST /api/agents/provision-outbound)
func (Unimplemented) PutTelemtUpdateStrategy ¶
func (_ Unimplemented) PutTelemtUpdateStrategy(w http.ResponseWriter, r *http.Request, id string)
Set an agent's Telemt update strategy (PUT /api/agents/{id}/telemt/update-strategy)
func (Unimplemented) RenameAgent ¶
func (_ Unimplemented) RenameAgent(w http.ResponseWriter, r *http.Request, id string)
Rename an agent's display node-name (PATCH /api/agents/{id})
func (Unimplemented) RevokeAgentCertificateRecoveryGrant ¶
func (_ Unimplemented) RevokeAgentCertificateRecoveryGrant(w http.ResponseWriter, r *http.Request, id string)
Revoke a previously-issued recovery grant (POST /api/agents/{id}/certificate-recovery-grants/revoke)
func (Unimplemented) RevokeEnrollmentToken ¶
func (_ Unimplemented) RevokeEnrollmentToken(w http.ResponseWriter, r *http.Request, value string)
Revoke an enrollment token (POST /api/agents/enrollment-tokens/{value}/revoke)
func (Unimplemented) UpdateAgentFleetGroup ¶
func (_ Unimplemented) UpdateAgentFleetGroup(w http.ResponseWriter, r *http.Request, id string)
Reassign an agent to a different fleet group (PUT /api/agents/{id}/fleet-group)
func (Unimplemented) UpdateAgentTransportMode ¶
func (_ Unimplemented) UpdateAgentTransportMode(w http.ResponseWriter, r *http.Request, id string)
Switch an agent between inbound and outbound transport (PUT /api/agents/{id}/transport-mode)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error
type UpdateAgentFleetGroup200JSONResponse ¶
type UpdateAgentFleetGroup200JSONResponse Agent
func (UpdateAgentFleetGroup200JSONResponse) VisitUpdateAgentFleetGroupResponse ¶
func (response UpdateAgentFleetGroup200JSONResponse) VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
type UpdateAgentFleetGroup400JSONResponse ¶
type UpdateAgentFleetGroup400JSONResponse struct{ BadRequestJSONResponse }
func (UpdateAgentFleetGroup400JSONResponse) VisitUpdateAgentFleetGroupResponse ¶
func (response UpdateAgentFleetGroup400JSONResponse) VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
type UpdateAgentFleetGroup401JSONResponse ¶
func (UpdateAgentFleetGroup401JSONResponse) VisitUpdateAgentFleetGroupResponse ¶
func (response UpdateAgentFleetGroup401JSONResponse) VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
type UpdateAgentFleetGroup403JSONResponse ¶
type UpdateAgentFleetGroup403JSONResponse struct{ ForbiddenJSONResponse }
func (UpdateAgentFleetGroup403JSONResponse) VisitUpdateAgentFleetGroupResponse ¶
func (response UpdateAgentFleetGroup403JSONResponse) VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
type UpdateAgentFleetGroup404JSONResponse ¶
type UpdateAgentFleetGroup404JSONResponse struct{ NotFoundJSONResponse }
func (UpdateAgentFleetGroup404JSONResponse) VisitUpdateAgentFleetGroupResponse ¶
func (response UpdateAgentFleetGroup404JSONResponse) VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
type UpdateAgentFleetGroupJSONRequestBody ¶
type UpdateAgentFleetGroupJSONRequestBody = UpdateAgentFleetGroupRequest
UpdateAgentFleetGroupJSONRequestBody defines body for UpdateAgentFleetGroup for application/json ContentType.
type UpdateAgentFleetGroupRequest ¶
type UpdateAgentFleetGroupRequest struct {
// FleetGroupId Target fleet-group UUID. Must already exist.
FleetGroupId string `json:"fleet_group_id"`
}
UpdateAgentFleetGroupRequest defines model for UpdateAgentFleetGroupRequest.
type UpdateAgentFleetGroupRequestObject ¶
type UpdateAgentFleetGroupRequestObject struct {
Id string `json:"id"`
Body *UpdateAgentFleetGroupJSONRequestBody
}
type UpdateAgentFleetGroupResponseObject ¶
type UpdateAgentFleetGroupResponseObject interface {
VisitUpdateAgentFleetGroupResponse(w http.ResponseWriter) error
}
type UpdateAgentTransportMode204Response ¶
type UpdateAgentTransportMode204Response struct {
}
func (UpdateAgentTransportMode204Response) VisitUpdateAgentTransportModeResponse ¶
func (response UpdateAgentTransportMode204Response) VisitUpdateAgentTransportModeResponse(w http.ResponseWriter) error
type UpdateAgentTransportMode400JSONResponse ¶
type UpdateAgentTransportMode400JSONResponse struct{ BadRequestJSONResponse }
func (UpdateAgentTransportMode400JSONResponse) VisitUpdateAgentTransportModeResponse ¶
func (response UpdateAgentTransportMode400JSONResponse) VisitUpdateAgentTransportModeResponse(w http.ResponseWriter) error
type UpdateAgentTransportMode401JSONResponse ¶
func (UpdateAgentTransportMode401JSONResponse) VisitUpdateAgentTransportModeResponse ¶
func (response UpdateAgentTransportMode401JSONResponse) VisitUpdateAgentTransportModeResponse(w http.ResponseWriter) error
type UpdateAgentTransportMode404JSONResponse ¶
type UpdateAgentTransportMode404JSONResponse struct{ NotFoundJSONResponse }
func (UpdateAgentTransportMode404JSONResponse) VisitUpdateAgentTransportModeResponse ¶
func (response UpdateAgentTransportMode404JSONResponse) VisitUpdateAgentTransportModeResponse(w http.ResponseWriter) error
type UpdateAgentTransportModeJSONRequestBody ¶
type UpdateAgentTransportModeJSONRequestBody = UpdateAgentTransportModeRequest
UpdateAgentTransportModeJSONRequestBody defines body for UpdateAgentTransportMode for application/json ContentType.
type UpdateAgentTransportModeRequest ¶
type UpdateAgentTransportModeRequest struct {
// DialAddress Public host:port the panel dials (required for outbound).
DialAddress *string `json:"dial_address,omitempty"`
// ListenAddress Agent-side bind spec. Optional — defaults to `:<port>`
// derived from `dial_address` when omitted.
ListenAddress *string `json:"listen_address,omitempty"`
TransportMode UpdateAgentTransportModeRequestTransportMode `json:"transport_mode"`
}
UpdateAgentTransportModeRequest defines model for UpdateAgentTransportModeRequest.
type UpdateAgentTransportModeRequestObject ¶
type UpdateAgentTransportModeRequestObject struct {
Id string `json:"id"`
Body *UpdateAgentTransportModeJSONRequestBody
}
type UpdateAgentTransportModeRequestTransportMode ¶
type UpdateAgentTransportModeRequestTransportMode string
UpdateAgentTransportModeRequestTransportMode defines model for UpdateAgentTransportModeRequest.TransportMode.
const ( Inbound UpdateAgentTransportModeRequestTransportMode = "inbound" Outbound UpdateAgentTransportModeRequestTransportMode = "outbound" )
Defines values for UpdateAgentTransportModeRequestTransportMode.
func (UpdateAgentTransportModeRequestTransportMode) Valid ¶
func (e UpdateAgentTransportModeRequestTransportMode) Valid() bool
Valid indicates whether the value is a known member of the UpdateAgentTransportModeRequestTransportMode enum.
type UpdateAgentTransportModeResponseObject ¶
type UpdateAgentTransportModeResponseObject interface {
VisitUpdateAgentTransportModeResponse(w http.ResponseWriter) error
}
type VersionResponse ¶
type VersionResponse struct {
// BuildTime RFC3339 build timestamp. Operator+ only.
BuildTime *time.Time `json:"build_time,omitempty"`
// CommitSha Git commit hash baked in at build time. Operator+ only.
CommitSha *string `json:"commit_sha,omitempty"`
// Version Semantic version (or "dev" for unstamped builds).
Version string `json:"version"`
}
VersionResponse Build metadata for the running control-plane process.