2023-06-18 15:02:21 +02:00
<!doctype html>
< html class = "no-js" lang = "en" >
< head > < meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" / >
< meta name = "color-scheme" content = "light dark" > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< link rel = "index" title = "Index" href = "../genindex.html" / > < link rel = "search" title = "Search" href = "../search.html" / > < link rel = "next" title = "OAuth2" href = "oauth2.html" / > < link rel = "prev" title = "Authentication and account" href = "auth.html" / >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
<!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20 -->
2023-06-25 14:00:35 +02:00
< title > Configuration - FitTrackee 0.7.18 documentation< / title >
2023-06-18 15:02:21 +02:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/styles/furo.css?digest=e6660623a769aa55fea372102b9bf3151b292993" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/copybutton.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" / >
2022-11-27 12:06:42 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/css/fork-awesome.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/css/custom.css" / >
2023-06-18 15:02:21 +02:00
< style >
body {
--color-code-background: #eeffcc;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #272822;
--color-code-foreground: #f8f8f2;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #272822;
--color-code-foreground: #f8f8f2;
}
}
}
< / style > < / head >
< body >
< script >
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
< / script >
< svg xmlns = "http://www.w3.org/2000/svg" style = "display: none;" >
< symbol id = "svg-toc" viewBox = "0 0 24 24" >
< title > Contents< / title >
< svg stroke = "currentColor" fill = "currentColor" stroke-width = "0" viewBox = "0 0 1024 1024" >
< path d = "M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z" / >
< / svg >
< / symbol >
< symbol id = "svg-menu" viewBox = "0 0 24 24" >
< title > Menu< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
< line x1 = "3" y1 = "12" x2 = "21" y2 = "12" > < / line >
< line x1 = "3" y1 = "6" x2 = "21" y2 = "6" > < / line >
< line x1 = "3" y1 = "18" x2 = "21" y2 = "18" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-arrow-right" viewBox = "0 0 24 24" >
< title > Expand< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
< polyline points = "9 18 15 12 9 6" > < / polyline >
< / svg >
< / symbol >
< symbol id = "svg-sun" viewBox = "0 0 24 24" >
< title > Light mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
< circle cx = "12" cy = "12" r = "5" > < / circle >
< line x1 = "12" y1 = "1" x2 = "12" y2 = "3" > < / line >
< line x1 = "12" y1 = "21" x2 = "12" y2 = "23" > < / line >
< line x1 = "4.22" y1 = "4.22" x2 = "5.64" y2 = "5.64" > < / line >
< line x1 = "18.36" y1 = "18.36" x2 = "19.78" y2 = "19.78" > < / line >
< line x1 = "1" y1 = "12" x2 = "3" y2 = "12" > < / line >
< line x1 = "21" y1 = "12" x2 = "23" y2 = "12" > < / line >
< line x1 = "4.22" y1 = "19.78" x2 = "5.64" y2 = "18.36" > < / line >
< line x1 = "18.36" y1 = "5.64" x2 = "19.78" y2 = "4.22" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-moon" viewBox = "0 0 24 24" >
< title > Dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< path d = "M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" / >
< / svg >
< / symbol >
< symbol id = "svg-sun-half" viewBox = "0 0 24 24" >
< title > Auto light/dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< circle cx = "12" cy = "12" r = "9" / >
< path d = "M13 12h5" / >
< path d = "M13 15h4" / >
< path d = "M13 18h1" / >
< path d = "M13 9h4" / >
< path d = "M13 6h1" / >
< / svg >
< / symbol >
< / svg >
< input type = "checkbox" class = "sidebar-toggle" name = "__navigation" id = "__navigation" >
< input type = "checkbox" class = "sidebar-toggle" name = "__toc" id = "__toc" >
< label class = "overlay sidebar-overlay" for = "__navigation" >
< div class = "visually-hidden" > Hide navigation sidebar< / div >
< / label >
< label class = "overlay toc-overlay" for = "__toc" >
< div class = "visually-hidden" > Hide table of contents sidebar< / div >
< / label >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
< div class = "page" >
< header class = "mobile-header" >
< div class = "header-left" >
< label class = "nav-overlay-icon" for = "__navigation" >
< div class = "visually-hidden" > Toggle site navigation sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-menu" > < / use > < / svg > < / i >
< / label >
< / div >
< div class = "header-center" >
2023-06-25 14:00:35 +02:00
< a href = "../index.html" > < div class = "brand" > FitTrackee 0.7.18
2023-06-18 15:02:21 +02:00
documentation< / div > < / a >
< / div >
< div class = "header-right" >
< div class = "theme-toggle-container theme-toggle-header" >
< button class = "theme-toggle" >
< div class = "visually-hidden" > Toggle Light / Dark / Auto color theme< / div >
< svg class = "theme-icon-when-auto" > < use href = "#svg-sun-half" > < / use > < / svg >
< svg class = "theme-icon-when-dark" > < use href = "#svg-moon" > < / use > < / svg >
< svg class = "theme-icon-when-light" > < use href = "#svg-sun" > < / use > < / svg >
2020-12-30 11:12:35 +01:00
< / button >
< / div >
2023-06-18 15:02:21 +02:00
< label class = "toc-overlay-icon toc-header-icon no-toc" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< / header >
< aside class = "sidebar-drawer" >
< div class = "sidebar-container" >
< div class = "sidebar-sticky" > < a class = "sidebar-brand" href = "../index.html" >
< div class = "sidebar-logo-container" >
< img class = "sidebar-logo" src = "../_static/ft-logo.png" alt = "Logo" / >
< / div >
2023-06-25 14:00:35 +02:00
< span class = "sidebar-brand-text" > FitTrackee 0.7.18
2023-06-18 15:02:21 +02:00
documentation< / span >
< / a > < form class = "sidebar-search-container" method = "get" action = "../search.html" role = "search" >
< input class = "sidebar-search" placeholder = "Search" name = "q" aria-label = "Search" >
< input type = "hidden" name = "check_keywords" value = "yes" >
< input type = "hidden" name = "area" value = "default" >
< / form >
< div id = "searchbox" > < / div > < div class = "sidebar-scroll" > < div class = "sidebar-tree" >
< ul class = "current" >
2020-12-30 11:12:35 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../features.html" > Features< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../oauth.html" > OAuth 2.0< / a > < / li >
2021-11-29 18:24:22 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../installation.html" > Installation< / a > < / li >
2022-04-24 13:17:38 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../cli.html" > Command line interface< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../third_party_tools.html" > Third-party tools< / a > < / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1 current has-children" > < a class = "reference internal" href = "index.html" > API documentation< / a > < input checked = "" class = "toctree-checkbox" id = "toctree-checkbox-1" name = "toctree-checkbox-1" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-1" > < div class = "visually-hidden" > Toggle navigation of API documentation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "auth.html" > Authentication and account< / a > < / li >
< li class = "toctree-l2 current current-page" > < a class = "current reference internal" href = "#" > Configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "oauth2.html" > OAuth2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "records.html" > Records< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "sports.html" > Sports< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "stats.html" > Statistics< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "users.html" > Users< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "workouts.html" > Workouts< / a > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../troubleshooting/index.html" > Troubleshooting< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-2" name = "toctree-checkbox-2" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-2" > < div class = "visually-hidden" > Toggle navigation of Troubleshooting< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../troubleshooting/administrator.html" > Administrator< / a > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../changelog.html" > Change log< / a > < / li >
< / ul >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
< / div >
2023-06-18 15:23:33 +02:00
< / div > < div id = "furo-languages" tabindex = "0" >
< span class = "languages-label" >
< i class = "fa fa-language" > < / i >
< / span >
< div class = "languages-list" >
< a href = "../../en/api/configuration.html" hreflang = en lang = en >
English
< / a >
< a href = "../../fr/api/configuration.html" hreflang = fr lang = fr >
Français
< / a >
< / div >
2023-06-18 15:02:21 +02:00
< / div >
< / div >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
< / div >
< / aside >
< div class = "main" >
< div class = "content" >
< div class = "article-container" >
< a href = "#" class = "back-to-top muted-link" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" >
< path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z" > < / path >
< / svg >
< span > Back to top< / span >
< / a >
< div class = "content-icon-container" >
< div class = "theme-toggle-container theme-toggle-content" >
< button class = "theme-toggle" >
< div class = "visually-hidden" > Toggle Light / Dark / Auto color theme< / div >
< svg class = "theme-icon-when-auto" > < use href = "#svg-sun-half" > < / use > < / svg >
< svg class = "theme-icon-when-dark" > < use href = "#svg-moon" > < / use > < / svg >
< svg class = "theme-icon-when-light" > < use href = "#svg-sun" > < / use > < / svg >
< / button >
< / div >
< label class = "toc-overlay-icon toc-content-icon no-toc" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< article role = "main" >
< section id = "configuration" >
< h1 > Configuration< a class = "headerlink" href = "#configuration" title = "Permalink to this heading" > #< / a > < / h1 >
2020-12-30 11:12:35 +01:00
< dl class = "http get" >
2021-11-06 21:26:02 +01:00
< dt class = "sig sig-object http" id = "get--api-config" >
2023-06-18 15:02:21 +02:00
< span class = "sig-name descname" > < span class = "pre" > GET< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > /api/config< / span > < / span > < a class = "headerlink" href = "#get--api-config" title = "Permalink to this definition" > #< / a > < / dt >
2022-08-27 16:50:29 +02:00
< dd > < p > Get Application configuration.< / p >
2020-12-30 11:12:35 +01:00
< p > < strong > Example request< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nf" > GET< / span > < span class = "nn" > /api/config< / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
< / pre > < / div >
< / div >
< p > < strong > Example response< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span > < span class = "m" > 200< / span > < span class = "ne" > OK< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
2023-02-16 11:18:50 +01:00
< span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
2023-03-05 14:26:31 +01:00
< span class = "w" > < / span > < span class = "nt" > " about" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > < span class = "nt" > " admin_contact" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin@example.com" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " gpx_limit_import" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " is_email_sending_enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " is_registration_enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_single_file_size" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1048576< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_users" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_zip_file_size" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10485760< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " map_attribution" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " & copy; < a href=http://www.openstreetmap.org/copyright> OpenStreetMap< /a> contributors" < / span > < span class = "p" > ,< / span >
2023-03-05 14:26:31 +01:00
< span class = "w" > < / span > < span class = "nt" > " privacy_policy" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " privacy_policy_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
2023-06-25 14:00:35 +02:00
< span class = "w" > < / span > < span class = "nt" > " version" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 0.7.18" < / span > < span class = "p" > ,< / span >
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > < span class = "nt" > " weather_provider" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span >
< span class = "p" > }< / span >
2020-12-30 11:12:35 +01:00
< / pre > < / div >
< / div >
< dl class = "field-list simple" >
2022-06-22 20:22:26 +02:00
< dt class = "field-odd" > Status Codes< span class = "colon" > :< / span > < / dt >
2020-12-30 11:12:35 +01:00
< dd class = "field-odd" > < ul class = "simple" >
2023-06-18 20:45:39 +02:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > success< / span > < / code > < / p > < / li >
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1" > 500 Internal Server Error< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > error< / span > < span class = "pre" > on< / span > < span class = "pre" > getting< / span > < span class = "pre" > configuration< / span > < / code > < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "http patch" >
2021-11-06 21:26:02 +01:00
< dt class = "sig sig-object http" id = "patch--api-config" >
2023-06-18 15:02:21 +02:00
< span class = "sig-name descname" > < span class = "pre" > PATCH< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > /api/config< / span > < / span > < a class = "headerlink" href = "#patch--api-config" title = "Permalink to this definition" > #< / a > < / dt >
2022-08-27 16:50:29 +02:00
< dd > < p > Update Application configuration.< / p >
< p > Authenticated user must be an admin.< / p >
< p > < strong > Scope< / strong > : < code class = "docutils literal notranslate" > < span class = "pre" > application:write< / span > < / code > < / p >
2020-12-30 11:12:35 +01:00
< p > < strong > Example request< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nf" > GET< / span > < span class = "nn" > /api/config< / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
< / pre > < / div >
< / div >
< p > < strong > Example response< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span > < span class = "m" > 200< / span > < span class = "ne" > OK< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
2023-02-16 11:18:50 +01:00
< span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
2023-03-05 14:26:31 +01:00
< span class = "w" > < / span > < span class = "nt" > " about" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > < span class = "nt" > " admin_contact" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin@example.com" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " gpx_limit_import" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " is_email_sending_enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " is_registration_enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_single_file_size" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1048576< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_users" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " max_zip_file_size" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10485760< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " map_attribution" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " & copy; < a href=http://www.openstreetmap.org/copyright> OpenStreetMap< /a> contributors" < / span > < span class = "p" > ,< / span >
2023-03-05 14:26:31 +01:00
< span class = "w" > < / span > < span class = "nt" > " privacy_policy" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " privacy_policy_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
2023-06-25 14:00:35 +02:00
< span class = "w" > < / span > < span class = "nt" > " version" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 0.7.18" < / span > < span class = "p" > ,< / span >
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > < span class = "nt" > " weather_provider" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span >
< span class = "p" > }< / span >
2020-12-30 11:12:35 +01:00
< / pre > < / div >
< / div >
< dl class = "field-list simple" >
2022-06-22 20:22:26 +02:00
< dt class = "field-odd" > Request JSON Object< span class = "colon" > :< / span > < / dt >
2020-12-30 11:12:35 +01:00
< dd class = "field-odd" > < ul class = "simple" >
2023-03-05 14:26:31 +01:00
< li > < p > < strong > about< / strong > (< em > string< / em > ) – < / p > < / li >
2022-03-26 20:30:37 +01:00
< li > < p > < strong > admin_contact< / strong > (< em > string< / em > ) – < / p > < / li >
2021-02-20 16:59:31 +01:00
< li > < p > < strong > gpx_limit_import< / strong > (< em > integer< / em > ) – < / p > < / li >
2022-08-27 16:50:29 +02:00
< li > < p > < strong > is_registration_enabled< / strong > (< em > boolean< / em > ) – < / p > < / li >
2021-02-20 16:59:31 +01:00
< li > < p > < strong > max_single_file_size< / strong > (< em > integer< / em > ) – < / p > < / li >
< li > < p > < strong > max_users< / strong > (< em > integer< / em > ) – < / p > < / li >
2022-04-03 19:47:40 +02:00
< li > < p > < strong > max_zip_file_size< / strong > (< em > integer< / em > ) – < / p > < / li >
2023-03-05 14:26:31 +01:00
< li > < p > < strong > privacy_policy< / strong > (< em > string< / em > ) – < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
2022-06-22 20:22:26 +02:00
< dt class = "field-even" > Request Headers< span class = "colon" > :< / span > < / dt >
2021-12-01 19:39:45 +01:00
< dd class = "field-even" > < ul class = "simple" >
2022-11-27 12:06:42 +01:00
< li > < p > < span > < a class = "reference external" href = "https://www.rfc-editor.org/rfc/rfc7235#section-4.2" > Authorization< / a > < / span > – < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
2022-06-22 20:22:26 +02:00
< dt class = "field-odd" > Status Codes< span class = "colon" > :< / span > < / dt >
2021-12-01 19:39:45 +01:00
< dd class = "field-odd" > < ul class = "simple" >
2023-06-18 20:45:39 +02:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > success< / span > < / code > < / p > < / li >
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1" > 400 Bad Request< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > invalid< / span > < span class = "pre" > payload< / span > < / code > < / p > < / li >
2021-11-06 21:26:02 +01:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > < / span > – < ul >
2023-06-18 20:45:39 +02:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > provide< / span > < span class = "pre" > a< / span > < span class = "pre" > valid< / span > < span class = "pre" > auth< / span > < span class = "pre" > token< / span > < / code > < / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > signature< / span > < span class = "pre" > expired,< / span > < span class = "pre" > please< / span > < span class = "pre" > log< / span > < span class = "pre" > in< / span > < span class = "pre" > again< / span > < / code > < / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > invalid< / span > < span class = "pre" > token,< / span > < span class = "pre" > please< / span > < span class = "pre" > log< / span > < span class = "pre" > in< / span > < span class = "pre" > again< / span > < / code > < / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > valid< / span > < span class = "pre" > email< / span > < span class = "pre" > must< / span > < span class = "pre" > be< / span > < span class = "pre" > provided< / span > < span class = "pre" > for< / span > < span class = "pre" > admin< / span > < span class = "pre" > contact< / span > < / code > < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / p > < / li >
2023-06-18 20:45:39 +02:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4" > 403 Forbidden< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > you< / span > < span class = "pre" > do< / span > < span class = "pre" > not< / span > < span class = "pre" > have< / span > < span class = "pre" > permissions< / span > < / code > < / p > < / li >
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1" > 500 Internal Server Error< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > error< / span > < span class = "pre" > when< / span > < span class = "pre" > updating< / span > < span class = "pre" > configuration< / span > < / code > < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "http get" >
2021-11-06 21:26:02 +01:00
< dt class = "sig sig-object http" id = "get--api-ping" >
2023-06-18 15:02:21 +02:00
< span class = "sig-name descname" > < span class = "pre" > GET< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > /api/ping< / span > < / span > < a class = "headerlink" href = "#get--api-ping" title = "Permalink to this definition" > #< / a > < / dt >
2020-12-30 11:12:35 +01:00
< dd > < p > health check endpoint< / p >
< p > < strong > Example request< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nf" > GET< / span > < span class = "nn" > /api/ping< / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
< / pre > < / div >
< / div >
< p > < strong > Example response< / strong > :< / p >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span > < span class = "m" > 200< / span > < span class = "ne" > OK< / span >
< span class = "na" > Content-Type< / span > < span class = "o" > :< / span > < span class = "l" > application/json< / span >
2023-02-16 11:18:50 +01:00
< span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " message" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " pong!" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span >
< span class = "p" > }< / span >
2020-12-30 11:12:35 +01:00
< / pre > < / div >
< / div >
< dl class = "field-list simple" >
2022-06-22 20:22:26 +02:00
< dt class = "field-odd" > Status Codes< span class = "colon" > :< / span > < / dt >
2020-12-30 11:12:35 +01:00
< dd class = "field-odd" > < ul class = "simple" >
2023-06-18 20:45:39 +02:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > < / span > – < code class = "docutils literal notranslate" > < span class = "pre" > success< / span > < / code > < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
2021-11-06 21:26:02 +01:00
< / section >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
< / article >
< / div >
< footer >
< div class = "related-pages" >
< a class = "next-page" href = "oauth2.html" >
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
< div class = "title" > OAuth2< / div >
< / div >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
< a class = "prev-page" href = "auth.html" >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< div class = "page-info" >
< div class = "context" >
< span > Previous< / span >
< / div >
< div class = "title" > Authentication and account< / div >
< / div >
< / a >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
Copyright © 2018 - 2023, SamR1
< / div >
Made with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > and < a class = "muted-link" href = "https://pradyunsg.me" > @pradyunsg< / a > 's
< a href = "https://github.com/pradyunsg/furo" > Furo< / a >
< / div >
< div class = "right-details" >
< div class = "icons" >
< a class = "muted-link fa fa-github fa-lg" href = "https://github.com/SamR1/FitTrackee" aria-label = "GitHub" > < / a >
2023-06-28 08:44:42 +02:00
< a class = "muted-link fa fa-mastodon fa-lg" rel = "me" href = "https://fosstodon.org/@FitTrackee" aria-label = "Mastodon" > < / a >
2023-06-18 15:02:21 +02:00
< / div >
< / div >
< / div >
< / footer >
2020-12-30 11:12:35 +01:00
< / div >
2023-06-18 15:02:21 +02:00
< aside class = "toc-drawer no-toc" >
2020-12-30 11:12:35 +01:00
2023-06-18 15:02:21 +02:00
< / aside >
2020-12-30 11:12:35 +01:00
< / div >
2023-06-18 15:02:21 +02:00
< / div > < script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/sphinx_highlight.js" > < / script >
< script src = "../_static/scripts/furo.js" > < / script >
< script src = "../_static/clipboard.min.js" > < / script >
< script src = "../_static/copybutton.js" > < / script >
< / body >
2020-12-30 11:12:35 +01:00
< / html >
