Configuration#

GET /api/config#

Obtenir la configuration de l’application.

Exemple de requête :

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

Exemple de réponse :

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.22",
    "weather_provider": null
  },
  "status": "success"
}
Codes d’état:
PATCH /api/config#

Mettre à jour de la configuration de l’application.

L’utilisateur authentifié doit avoir des droits d’administration.

Scope : application:write

Exemple de requête :

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

Exemple de réponse :

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.22",
    "weather_provider": null
  },
  "status": "success"
}
Objet JSON de requête:
  • about (string) – informations de l’instance

  • admin_contact (string) – adresse électronique pour contacter l’administrateur

  • gpx_limit_import (integer) – nombre maximum de fichiers dans l’archive zip

  • is_registration_enabled (boolean) – l’inscription est-elle activée ?

  • max_single_file_size (integer) – taille maximale d’un fichier

  • max_users (integer) – nombre maximum d’utilisateurs autorisés à s’inscrire sur l’instance

  • max_zip_file_size (integer) – taille maximale d’une archive zip

  • privacy_policy (string) – politique de confidentialité de l’instance

En-têtes de requête:
Codes d’état:
GET /api/ping#

point d’accès de contrôle

Exemple de requête :

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

Exemple de réponse :

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

{
  "message": "pong!",
  "status": "success"
}
Codes d’état: