api

May 22, 2026

Changes in this version

+ const NIP86ContentType

+ var ErrMissingAuthHeader = errors.New("missing Authorization header")

+ func ExtractNIP98Event(r *http.Request) (nostr.Event, error)

+ func FetchAdminMutelist(w http.ResponseWriter, r *http.Request)

+ func HandleNIP86(w http.ResponseWriter, r *http.Request)

+ func IsRelayOwner(pubkey string) bool

+ func RequireOwner(w http.ResponseWriter, r *http.Request) (string, bool)

+ func SetServerStatsHook(fn func() ServerStats)

+ func SyncAdminMutelist(w http.ResponseWriter, r *http.Request)

+ func VerifyAPIAuth(r *http.Request) (string, error)

type BackupRelayConfigResponse

+ URLs []string

type BlacklistKeysResponse

+ AdminMutelistCount int

+ type ServerStats struct

+ ActiveConnections int64

+ BuildTime string

+ GitCommit string

+ TotalMessagesSent int64

+ UptimeSeconds int64

+ Version string

Apr 25, 2026

Changes in this version

type AuthConfigResponse

+ Required bool

type ServerConfigResponse

+ MaxConnections int

Jul 15, 2025

Changes in this version

+ func GetAllBlacklistedPubkeys(w http.ResponseWriter, r *http.Request)

+ func GetAllBlacklistedPubkeysLive(w http.ResponseWriter, r *http.Request)

+ func GetAllWhitelistedPubkeys(w http.ResponseWriter, r *http.Request)

+ func GetAllWhitelistedPubkeysLive(w http.ResponseWriter, r *http.Request)

+ func GetAuthConfig(w http.ResponseWriter, r *http.Request)

+ func GetBackupRelayConfig(w http.ResponseWriter, r *http.Request)

+ func GetBlacklistConfig(w http.ResponseWriter, r *http.Request)

+ func GetEventPurgeConfig(w http.ResponseWriter, r *http.Request)

+ func GetEventTimeConstraintsConfig(w http.ResponseWriter, r *http.Request)

+ func GetLoggingConfig(w http.ResponseWriter, r *http.Request)

+ func GetMongoDBConfig(w http.ResponseWriter, r *http.Request)

+ func GetRateLimitConfig(w http.ResponseWriter, r *http.Request)

+ func GetResourceLimitsConfig(w http.ResponseWriter, r *http.Request)

+ func GetServerConfig(w http.ResponseWriter, r *http.Request)

+ func GetUserSyncConfig(w http.ResponseWriter, r *http.Request)

+ func GetWhitelistConfig(w http.ResponseWriter, r *http.Request)

+ type AuthConfigResponse struct

+ Enabled bool

+ RelayURL string

+ type BackupRelayConfigResponse struct

+ Enabled bool

+ URL string

+ type BlacklistConfigResponse struct

+ Enabled bool

+ MaxTempBans int

+ MuteListAuthors []string

+ MutelistCacheRefreshMinutes int

+ PermanentBanWords []string

+ PermanentBlacklistNpubs []string

+ PermanentBlacklistPubkeys []string

+ TempBanDuration int

+ TempBanWords []string

+ type BlacklistKeysResponse struct

+ Mutelist map[string][]string

+ Permanent []string

+ Temporary []map[string]interface{}

+ type EventPurgeConfigResponse struct

+ DisableAtStartup bool

+ Enabled bool

+ ExcludeWhitelisted bool

+ KeepIntervalHours int

+ KindsToPurge []int

+ PurgeByCategory map[string]bool

+ PurgeByKindEnabled bool

+ PurgeIntervalMinutes int

+ type EventTimeConstraintsConfigResponse struct

+ MaxCreatedAt int64

+ MaxCreatedAtString string

+ MinCreatedAt int64

+ MinCreatedAtString string

+ type LoggingConfigResponse struct

+ BackupCount int

+ CheckIntervalMin int

+ File string

+ Level string

+ MaxSizeMB int

+ Structure bool

+ SuppressComponents []string

+ type MongoDBConfigResponse struct

+ Database string

+ URI string

+ type RateLimitConfigResponse struct

+ CategoryLimits map[string]cfgType.KindLimitConfig

+ EventBurst int

+ EventLimit float64

+ KindLimits []cfgType.KindLimitConfig

+ KindSizeLimits []cfgType.KindSizeLimitConfig

+ MaxEventSize int

+ ReqBurst int

+ ReqLimit float64

+ WsBurst int

+ WsLimit float64

+ type ResourceLimitsConfigResponse struct

+ CPUCores int

+ HeapSizeMB int

+ MemoryMB int

+ type ServerConfigResponse struct

+ IdleTimeout int

+ ImplicitReqLimit int

+ MaxSubscriptionsPerClient int

+ ReadTimeout int

+ WriteTimeout int

+ type UserSyncConfigResponse struct

+ Categories string

+ DisableAtStartup bool

+ ExcludeNonWhitelisted bool

+ InitialSyncRelays []string

+ Interval int

+ Kinds []int

+ Limit *int

+ UserSync bool

+ type WhitelistConfigResponse struct

+ DomainWhitelist struct{ ... }

+ KindWhitelist struct{ ... }

+ PubkeyWhitelist struct{ ... }

+ type WhitelistDomainInfo struct

+ Domain string

+ Pubkeys []string

+ type WhitelistKeysResponse struct

+ Domains []WhitelistDomainInfo

+ List []string