/
RU
runtipi
/
Runtipi API
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
OpenAPI 3.1.0
2026-07-17
81
53
139.9 KB
App
get
/api/user-context
Response
UserContextDto
required
allowAutoThemes
boolean
required
allowErrorMonitoring
boolean
required
isConfigured
boolean
required
isGuestDashboardEnabled
boolean
required
isLoggedIn
boolean
required
localDomain
string
required
sslPort
number
required
themeBase
string
required
themeColor
string
required
version
object
required
All 81 operations
get
/api/user-context
get
/api/app-context
patch
/api/user-settings
patch
/api/acknowledge-welcome
get
/api/system/load
get
/api/system/certificate
get
/api/i18n/locales/{ns}/{lng}.json
post
/api/auth/login
post
/api/auth/verify-totp
post
/api/auth/register
post
/api/auth/logout
post
/api/auth/forward-auth
patch
/api/auth/username
patch
/api/auth/password
patch
/api/auth/totp/get-uri
patch
/api/auth/totp/setup
patch
/api/auth/totp/disable
post
/api/auth/reset-password
get
/api/auth/traefik
get
/api/apps/installed
get
/api/apps/guest
post
/api/apps/random-port
get
/api/apps/{urn}
get
/api/apps/{urn}/compose-diff
get
/api/apps/{urn}/config-diff
patch
/api/apps/{urn}/ignore-version
patch
/api/apps/{urn}/unignore-version
get
/api/marketplace/apps/search
get
/api/marketplace/apps/{urn}/image
post
/api/marketplace/pull
post
/api/marketplace/create
get
/api/marketplace/all
get
/api/marketplace/enabled
delete
/api/marketplace/{id}
patch
/api/marketplace/{id}
post
/api/app-lifecycle/{urn}/install
post
/api/app-lifecycle/{urn}/start
post
/api/app-lifecycle/{urn}/stop
post
/api/app-lifecycle/{urn}/restart
delete
/api/app-lifecycle/{urn}/uninstall
post
/api/app-lifecycle/{urn}/reset
patch
/api/app-lifecycle/{urn}/update
patch
/api/app-lifecycle/{urn}/update-config
patch
/api/app-lifecycle/update-all
post
/api/app-lifecycle/start-all
post
/api/app-lifecycle/stop-all
post
/api/app-lifecycle/restart-all
get
/api/sse/app
get
/api/sse/app-logs
get
/api/sse/runtipi-logs
get
/api/links/guest
get
/api/links
post
/api/links
delete
/api/links/{id}
patch
/api/links/{id}
post
/api/backups/{urn}/backup
post
/api/backups/{urn}/restore
get
/api/backups/{urn}
delete
/api/backups/{urn}
get
/api/backups/{urn}/{filename}/download
post
/api/backups/{urn}/upload
get
/api/health
get
Get the user configuration for an app
put
Update the user configuration for an app
post
Enable the user configuration for an app
post
Disable the user configuration for an app
post
/api/custom-apps
patch
/api/custom-apps/{urn}
post
/api/custom-apps/{urn}/image
patch
/api/custom-apps/{urn}/metadata
get
post
get
post
post
/api/debug/seed
post
/api/debug/set-all-app-update-available
post
/api/debug/set-all-subnets-to-null
post
/api/debug/start-all-apps
post
/api/debug/backup-all-apps
post
/api/debug/increment-all-app-versions
post
/api/debug/uninstall-all-apps