apipaths

package
v0.1.151 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2026 License: GPL-2.0, GPL-3.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PathHealth                 = "/api/health"
	PathMetrics                = "/metrics"
	PathAuthSetupStatus        = "/api/auth/setup"
	PathAuthSetupCreate        = "/api/auth/setup"
	PathLogin                  = "/api/auth/login"
	PathLogout                 = "/api/auth/logout"
	PathOidcRedirect           = "/api/auth/oidc"
	PathOidcCallback           = "/api/auth/oidc/callback"
	PathOidcLink               = "/api/auth/oidc/link"
	PathWebauthnLoginBegin     = "/api/auth/webauthn/login/begin"
	PathWebauthnLoginFinish    = "/api/auth/webauthn/login/finish"
	PathEvents                 = "/api/events"
	PathMe                     = "/api/auth/me"
	PathChangePassword         = "/api/auth/password"
	PathListPasskeys           = "/api/auth/passkeys"
	PathWebauthnSignalData     = "/api/auth/webauthn/signal-data"
	PathWebauthnRegisterBegin  = "/api/auth/webauthn/register/begin"
	PathWebauthnRegisterFinish = "/api/auth/webauthn/register/finish"
	PathRenamePasskey          = "/api/auth/passkeys/{id}"
	PathConfigSchema           = "/api/config/schema"
	PathValidateConfigPath     = "/api/config/validate-path"
	PathListAlerts             = "/api/alerts"
	PathDismissAlert           = "/api/alerts"
	PathListActivity           = "/api/activity"
	PathDismissActivity        = "/api/activity"
	PathCancelActivity         = "/api/activity/{id}/cancel"
	PathDeletePasskey          = "/api/auth/passkeys/{id}"
	PathOidcUnlink             = "/api/auth/oidc/link"
	PathListUsers              = "/api/auth/users"
	PathCreateUser             = "/api/auth/users"
	PathDeleteUser             = "/api/auth/users/{id}"
	PathListAPIKeys            = "/api/auth/apikeys"
	PathGenerateAPIKey         = "/api/auth/apikeys"
	PathRevokeAPIKey           = "/api/auth/apikeys/{id}"
	PathConfigYAML             = "/api/config"
	PathSaveConfigYAML         = "/api/config"
	PathSaveConfigYAMLPost     = "/api/config"
	PathConfigStructured       = "/api/config/structured"
	PathSaveConfigStructured   = "/api/config/structured"
	PathResetConfig            = "/api/config/reset"
	PathConfigParsed           = "/api/config/parsed"
	PathManualSearch           = "/api/search"
	PathSearchResolve          = "/api/search/resolve"
	PathSearchTargets          = "/api/search/targets"
	PathListState              = "/api/state"
	PathStateStats             = "/api/state/stats"
	PathStateIDs               = "/api/state/ids"
	PathListBackoff            = "/api/backoff"
	PathBackoffPrefix          = "/api/backoff/prefix"
	PathListLocks              = "/api/locks"
	PathListProviders          = "/api/providers"
	PathProviderTimeouts       = "/api/providers/timeout"
	PathMediaSeries            = "/api/media/series"
	PathMediaMovies            = "/api/media/movies"
	PathMediaEpisodes          = "/api/media/series/{id}/episodes"
	PathCoverageSeries         = "/api/coverage/series"
	PathCoverageMovies         = "/api/coverage/movies"
	PathCoverageSeriesDetail   = "/api/coverage/series/{tvdbId}"
	PathCoverageScanState      = "/api/coverage/scan-state"
	PathDownloadSubtitle       = "/api/search/download"
	PathClearLock              = "/api/search/clear-lock"
	PathScoreRelease           = "/api/score"
	PathListFiles              = "/api/files"
	PathDeleteFile             = "/api/files"
	PathBulkDeleteFiles        = "/api/files/bulk"
	PathSyncAudio              = "/api/sync/audio"
	PathSyncOffset             = "/api/sync/offset"
	PathPreviewStart           = "/api/preview/start"
	PathPreviewSubtitle        = "/api/preview/subtitle"
	PathPreviewVideo           = "/api/preview/video"
	PathPreviewPoster          = "/api/preview/poster"
	PathStartScan              = "/api/scan"
	PathScanSeries             = "/api/scan/series/{id}"
	PathScanSeason             = "/api/scan/season/{id}/{season}"
	PathScanMovie              = "/api/scan/movie/{id}"
	PathScanItem               = "/api/scan/item"
	PathResetProviderTimeouts  = "/api/providers/timeout/reset"
)

HTTP API path constants generated from the endpoint table. Parameterized paths keep their {name} placeholders.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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