2020-12-30 11:12:35 +01:00
<!DOCTYPE html>
2022-06-22 20:22:26 +02:00
< html lang = "en" >
2020-12-30 11:12:35 +01:00
< head >
< meta charset = "utf-8" / >
2022-07-27 11:10:29 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2021-11-03 12:41:23 +01:00
2022-09-14 09:55:02 +02:00
< title > Configuration — FitTrackee 0.6.12
2020-12-30 11:12:35 +01:00
documentation< / title >
2021-11-06 21:26:02 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/bootstrap-sphinx.css" / >
2020-12-30 11:12:35 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/custom.css" / >
2021-11-06 21:26:02 +01:00
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
2020-12-30 11:12:35 +01:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
2022-06-22 20:22:26 +02:00
< script src = "../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2020-12-30 11:12:35 +01:00
< script src = "../_static/doctools.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Records" href = "records.html" / >
< link rel = "prev" title = "Authentication" href = "auth.html" / >
< meta charset = 'utf-8' >
< meta http-equiv = 'X-UA-Compatible' content = 'IE=edge,chrome=1' >
< meta name = 'viewport' content = 'width=device-width, initial-scale=1.0, maximum-scale=1' >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
2022-02-05 22:09:17 +01:00
< script type = "text/javascript" src = "../_static/js/jquery-1.12.4.min.js" > < / script >
< script type = "text/javascript" src = "../_static/js/jquery-fix.js" > < / script >
< script type = "text/javascript" src = "../_static/bootstrap-3.4.1/js/bootstrap.min.js" > < / script >
< script type = "text/javascript" src = "../_static/bootstrap-sphinx.js" > < / script >
2020-12-30 11:12:35 +01:00
< / head > < body >
< div id = "navbar" class = "navbar navbar-default navbar-fixed-top" >
< div class = "container" >
< div class = "navbar-header" >
<!-- .btn - navbar is used as the toggle for collapsed navbar content -->
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../index.html" >
FitTrackee< / a >
2022-09-14 09:55:02 +02:00
< span class = "navbar-text navbar-version pull-left" > < b > 0.6.12
2020-12-30 11:12:35 +01:00
< / b > < / span >
< / div >
< div class = "collapse navbar-collapse nav-collapse" >
< ul class = "nav navbar-nav" >
< li > < a href = "https://github.com/SamR1/FitTrackee" > GitHub< / a > < / li >
< li class = "dropdown globaltoc-container" >
< a role = "button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="../index.html">Docs < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc">< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "../features.html" > Features< / 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 >
2020-12-30 11:12:35 +01:00
< li class = "toctree-l1 current" > < a class = "reference internal" href = "index.html" > API documentation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../troubleshooting/index.html" > Troubleshooting< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../changelog.html" > Change log< / a > < / li >
< / ul >
< / ul >
< / li >
< li class = "dropdown" >
< a role = "button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc">< ul >
< li > < a class = "reference internal" href = "#" > Configuration< / a > < / li >
< / ul >
< / ul >
< / li >
< li >
< a href = "auth.html" title = "Previous Chapter: Authentication" > < span class = "glyphicon glyphicon-chevron-left visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > « Authentication< / span >
< / a >
< / li >
< li >
< a href = "records.html" title = "Next Chapter: Records" > < span class = "glyphicon glyphicon-chevron-right visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > Records » < / span >
< / a >
< / li >
< li class = "hidden-sm" >
< div id = "sourcelink" >
< a href = "../_sources/api/configuration.rst.txt"
rel="nofollow">Source< / a >
< / div > < / li >
< / ul >
< form class = "navbar-form navbar-right" action = "../search.html" method = "get" >
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search" / >
< / div >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< / div >
< div class = "container" >
< div class = "row" >
< div class = "body col-md-12 content" role = "main" >
2021-11-06 21:26:02 +01:00
< section id = "configuration" >
2022-06-22 20:22:26 +02:00
< 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" >
< 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 >
2020-12-30 11:12:35 +01:00
< dd > < p > Get Application config< / 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/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 >
2022-01-01 19:44:45 +01:00
< span class = "p" > {< / span > < span class = "w" > < / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span >
2022-04-03 19:47:40 +02: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 >
2022-01-01 19:44:45 +01:00
< 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 >
2022-04-24 13:17:38 +02:00
< 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 >
2022-01-01 19:44:45 +01:00
< 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 = "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 = "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 >
2022-04-03 19:47:40 +02:00
< 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 >
2022-01-01 19:44:45 +01:00
< span class = "w" > < / span > < span class = "nt" > " map_attribution" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "nt" > " & copy; < a href=http://www.openstreetmap.org/copyright> OpenStreetMap< /a> contributors" < / span > < span class = "w" > < / span >
2022-09-14 09:55:02 +02:00
< span class = "w" > < / span > < span class = "nt" > " version" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 0.6.12" < / span > < span class = "w" > < / span >
2022-01-01 19:44:45 +01:00
< span class = "w" > < / span > < span class = "p" > },< / span > < span class = "w" > < / 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 = "w" > < / span >
< span class = "p" > }< / span > < span class = "w" > < / 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" >
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.2.1" > 200 OK< / a > < / span > – < / 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 > – < / 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" >
< 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 >
2020-12-30 11:12:35 +01:00
< dd > < p > Update Application config< / p >
< p > Authenticated user must be an admin< / 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/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 >
2022-01-01 19:44:45 +01:00
< span class = "p" > {< / span > < span class = "w" > < / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span >
2022-03-26 20:30:37 +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 >
2022-01-01 19:44:45 +01:00
< 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 >
2022-04-24 13:17:38 +02:00
< 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 >
2022-04-03 19:47:40 +02:00
< 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 >
2022-01-01 19:44:45 +01:00
< 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 >
2022-04-03 19:47:40 +02:00
< 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 >
2022-01-01 19:44:45 +01:00
< 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 >
2022-04-03 19:47:40 +02:00
< span class = "w" > < / span > < span class = "nt" > " map_attribution" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "nt" > " & copy; < a href=http://www.openstreetmap.org/copyright> OpenStreetMap< /a> contributors" < / span > < span class = "w" > < / span >
2022-09-14 09:55:02 +02:00
< span class = "w" > < / span > < span class = "nt" > " version" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 0.6.12" < / span > < span class = "w" > < / span >
2022-01-01 19:44:45 +01:00
< span class = "w" > < / span > < span class = "p" > },< / span > < span class = "w" > < / 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 = "w" > < / span >
< span class = "p" > }< / span > < span class = "w" > < / 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" >
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 >
2020-12-30 11:12:35 +01: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 >
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" >
2021-11-06 21:26:02 +01:00
< li > < p > < span > < a class = "reference external" href = "https://tools.ietf.org/html/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" >
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.2.1" > 200 OK< / a > < / span > – < / 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 > – < / p > < / li >
< 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 >
2021-11-03 12:41:23 +01:00
< li > < p > provide a valid auth token< / p > < / li >
< li > < p > signature expired, please log in again< / p > < / li >
< li > < p > invalid token, please log in again< / p > < / li >
2022-03-26 20:30:37 +01:00
< li > < p > valid email must be provided for admin contact< / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / 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.4" > 403 Forbidden< / a > < / span > – < / 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 > – < / 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" >
< 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 >
2022-01-01 19:44:45 +01:00
< span class = "p" > {< / span > < span class = "w" > < / 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 = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span > < span class = "w" > < / span >
< span class = "p" > }< / span > < span class = "w" > < / 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" >
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.2.1" > 200 OK< / a > < / span > – < / 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
< / div >
< / div >
< / div >
< footer class = "footer" >
< div class = "container" >
< p class = "pull-right" >
< a href = "#" > Back to top< / a >
< / p >
< p >
2022-01-01 19:44:45 +01:00
© Copyright 2018 - 2022, SamR1.< br / >
2022-07-27 11:10:29 +02:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 5.1.1.< br / >
2020-12-30 11:12:35 +01:00
< / p >
< / div >
< / footer >
< / body >
< / html >
