summaryrefslogtreecommitdiff
path: root/docs/admin/api.rst
blob: 94508a28c0b5cf4e8378c234f81bc344abd35a75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.. _adminapi:

Administration API
------------------

Get configuration data
~~~~~~~~~~~~~~~~~~~~~~

.. code:: sh

    GET /config

Sample response
```````````````

.. code:: sh
    
    {
      "autocomplete": "", 
      "categories": [
        "map", 
        "it", 
        "images", 
      ], 
      "default_locale": "", 
      "default_theme": "oscar", 
      "engines": [
        {
          "categories": [
            "map"
          ], 
          "enabled": true, 
          "name": "openstreetmap", 
          "shortcut": "osm"
        }, 
        {
          "categories": [
            "it"
          ], 
          "enabled": true, 
          "name": "arch linux wiki", 
          "shortcut": "al"
        }, 
        {
          "categories": [
            "images"
          ], 
          "enabled": true, 
          "name": "google images", 
          "shortcut": "goi"
        }, 
        {
          "categories": [
            "it"
          ], 
          "enabled": false, 
          "name": "bitbucket", 
          "shortcut": "bb"
        }, 
      ], 
      "instance_name": "searx", 
      "locales": {
        "de": "Deutsch (German)", 
        "en": "English", 
        "eo": "Esperanto (Esperanto)", 
      }, 
      "plugins": [
        {
          "enabled": true, 
          "name": "HTTPS rewrite"
        }, 
        {
          "enabled": false, 
          "name": "Vim-like hotkeys"
        }
      ], 
      "safe_search": 0
    }