Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Configuration

GET /api/config

  Get Application configuration.

  Example request:

      GET /api/config HTTP/1.1
      Content-Type: application/json

  Example response:

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "data": {
          "about": null,
          "admin_contact": "admin@example.com",
          "gpx_limit_import": 10,
          "is_email_sending_enabled": true,
          "is_registration_enabled": false,
          "max_single_file_size": 1048576,
          "max_users": 0,
          "max_zip_file_size": 10485760,
          "map_attribution": "&copy; <a href=http://www.openstreetmap.org/copyright>OpenStreetMap</a> contributors",
          "privacy_policy": null,
          "privacy_policy_date": null,
          "version": "0.7.20",
          "weather_provider": null
        },
        "status": "success"
      }

  Status Codes:

    - 200 OK – `success`

    - 500 Internal Server Error – `error on getting configuration`

PATCH /api/config

  Update Application configuration.

  Authenticated user must be an admin.

  Scope: `application:write`

  Example request:

      GET /api/config HTTP/1.1
      Content-Type: application/json

  Example response:

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "data": {
          "about": null,
          "admin_contact": "admin@example.com",
          "gpx_limit_import": 10,
          "is_email_sending_enabled": true,
          "is_registration_enabled": false,
          "max_single_file_size": 1048576,
          "max_users": 10,
          "max_zip_file_size": 10485760,
          "map_attribution": "&copy; <a href=http://www.openstreetmap.org/copyright>OpenStreetMap</a> contributors",
          "privacy_policy": null,
          "privacy_policy_date": null,
          "version": "0.7.20",
          "weather_provider": null
        },
        "status": "success"
      }

  Request JSON Object:

    - about (string) – instance information

    - admin_contact (string) – email to contact the administrator

    - gpx_limit_import (integer) – max number of files in zip archive

    - is_registration_enabled (boolean) – is registration enabled?

    - max_single_file_size (integer) – max size of a single file

    - max_users (integer) – max users allowed to register on instance

    - max_zip_file_size (integer) – max size of a zip archive

    - privacy_policy (string) – instance privacy policy

  Request Headers:

    - Authorization – OAuth 2.0 Bearer Token

  Status Codes:

    - 200 OK – `success`

    - 400 Bad Request – `invalid payload`

    - 401 Unauthorized –

      - `provide a valid auth token`

      - `signature expired, please log in again`

      - `invalid token, please log in again`

      - `valid email must be provided for admin contact`

    - 403 Forbidden – `you do not have permissions`

    - 500 Internal Server Error – `error when updating configuration`

GET /api/ping

  health check endpoint

  Example request:

      GET /api/ping HTTP/1.1
      Content-Type: application/json

  Example response:

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "message": "pong!",
        "status": "success"
      }

  Status Codes:

    - 200 OK – `success`