api

package

Go to main page

Versions in this module

v0

v0.6.0

Sep 9, 2026

Changes in this version

type Option

+ func WithLimits(l limits.Limits) Option

v0.5.0

Sep 8, 2026

Changes in this version

+ const MaxDynamicClients

+ const RoleModeler

+ const RoleOperator

+ const SourceOIDC

+ func SeedStateFromCheckpoint(dataDir string) (bool, error)

+ func SetMaxFolderScanForTest(n int) func()

+ type OIDCConfig struct

+ ClientID string

+ ClientSecret string

+ Issuer string

+ Name string

+ Scopes string

type Option

+ func WithDynamicClientRegistration() Option

+ func WithExternalURL(origin string) Option

+ func WithMCP(h http.Handler) Option

+ func WithMetricsQuery(cfg promquery.Config) Option

+ func WithOIDC(cfg OIDCConfig) Option

+ func WithPlaygroundSessions(ttl, sweep time.Duration) Option

+ func WithSQLProbe(p SQLProbe) Option

+ func WithTargetTLSRoots(pool *x509.CertPool) Option

+ type SQLProbe func(ctx context.Context, product sqldb.Product, dsn string) error

type User

+ RolesUpgradedAt int64

+ type WorkerRuntimeMode string

+ const WorkerRuntimeModeAtlasEmbedded

+ const WorkerRuntimeModeAtlasSupervised

+ const WorkerRuntimeModeExternal

+ type WorkerTypeDefinition struct

+ ID string

+ Origin WorkerTypeOrigin

+ Placement string

+ RuntimeMode WorkerRuntimeMode

+ Title string

+ Vendor string

+ Version string

+ WorkerTypeID string

+ type WorkerTypeOrigin string

+ const WorkerTypeOriginBuiltIn

v0.4.0

Aug 26, 2026

Changes in this version

+ const GrantActionShare

+ const GrantActionTransfer

+ const GrantActionUnshare

+ const GrantActionVisibility

+ const HistoryScopeAll

+ const HistoryScopeFailed

+ const PrincipalTypeGroup

+ func DefaultSupervisedWorkerOnlyKinds() []string

+ func IsOffloadableKind(name string) bool

type Option

+ func WithPublicFormsCORS(origins []string) Option

+ func WithWorkerHistory(connector, scope string) Option

v0.3.0

Aug 21, 2026

Changes in this version

+ const ExitNothingToServe

+ func DefaultOffloadedKinds() []string

type Option

+ func WithOffloadedConnectorKinds(kinds []string) Option

+ func WithSupervisedWorkers(serverURL string, specs []SuperviseSpec, handles [][]string) Option

+ func WithTracing() Option

type Server

+ SuperviseSpecs []SuperviseSpec

+ type SuperviseSpec struct

+ Connectors []string

+ ID string

+ Kinds []string

v0.2.0

Aug 19, 2026

Changes in this version

+ const DefaultRetentionBatch

+ const DefaultRetentionInterval

+ const RoleDeployAgent

type Option

+ func WithCheckpointRetention(keep int) Option

+ func WithCheckpoints(every time.Duration) Option

+ func WithOpenSearchExportInterval(d time.Duration) Option

+ func WithOpenSearchExporter(cfg opensearch.Config) Option

+ func WithRetention(maxAge time.Duration) Option

+ func WithRetentionBatch(n int) Option

+ func WithRetentionInterval(d time.Duration) Option

+ func WithSystemProcesses() Option

+ func WithUserProvisioning() Option

+ func WithWALCompaction() Option

+ func WithoutMetrics() Option

v0.1.0

Aug 11, 2026

Changes in this version

+ const PrincipalTypeUser

+ const RoleAdmin

+ const RoleUser

+ const ScopeRoleEditor

+ const ScopeRoleOwner

+ const ScopeRoleViewer

+ const SourceLocal

+ const VisibilityPrivate

+ const VisibilityShared

+ var Version = "0.1.0-dev"

+ func ApplyPendingRestore(dataDir string) (bool, error)

+ type BuildInfo struct

+ Go string

+ Modified bool

+ Revision string

+ Time string

+ Version string

+ func Build() BuildInfo

+ type LogBuffer struct

+ func NewLogBuffer(max int) *LogBuffer

+ func (b *LogBuffer) Lines() []string

+ func (b *LogBuffer) Write(p []byte) (int, error)

+ type Option func(*Server)

+ func WithAuth() Option

+ func WithCollabKeepaliveInterval(d time.Duration) Option

+ func WithInboundBatchLimit(n int) Option

+ func WithInboundPollInterval(d time.Duration) Option

+ func WithLogBuffer(b *LogBuffer) Option

+ func WithScriptWorker(jobType int32, exec script.Exec) Option

+ func WithoutDocs() Option

+ func WithoutVault() Option

+ type Principal struct

+ Roles []string

+ UserID string

+ Username string

+ type ResetPasswordOptions struct

+ CreateAdmin bool

+ DataDir string

+ NewPassword string

+ Now int64

+ Username string

+ type ResetPasswordResult struct

+ Created bool

+ UserID string

+ Username string

+ func ResetPassword(opts ResetPasswordOptions) (ResetPasswordResult, error)

+ type Server struct

+ func New(proc *engine.Processor, store *state.Store, dataDir string, opts ...Option) (*Server, error)

+ func (s *Server) Close()

+ func (s *Server) Handler() http.Handler

+ func (s *Server) InternalToken() string

+ type User struct

+ CreatedAt int64

+ Disabled bool

+ DisplayName string

+ Email string

+ ExternalID string

+ ID string

+ PasswordHash string

+ Roles []string

+ Source string

+ UpdatedAt int64

+ Username string

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