free
/
searx
Volgen 1
Ster 0
Vork 0
Code Kwesties 0 Pull-aanvragen 0 Publicaties 11 Wiki Activiteit
79 Commits
10 Branches
Tree: 23e3afa432
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van '23e3afa432'
${ noResults }
searx/admin/api.html

api.html 10KB
Geschiedenis Ruw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">

  6.   <head>

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  9.     <title>Administration API &#8212; searx 0.12.0 documentation</title>

  10.     <link rel="stylesheet" href="../_static/style.css" type="text/css" />

  11.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  12.     <script type="text/javascript" src="../_static/documentation_options.js"></script>

  13.     <script type="text/javascript" src="../_static/jquery.js"></script>

  14.     <script type="text/javascript" src="../_static/underscore.js"></script>

  15.     <script type="text/javascript" src="../_static/doctools.js"></script>

  16.     <link rel="index" title="Index" href="../genindex.html" />

  17.     <link rel="search" title="Search" href="../search.html" />

  18.     <link rel="next" title="How to protect an instance" href="filtron.html" />

  19.     <link rel="prev" title="Installation" href="../dev/install/installation.html" />

  20.    

  21.   

  22.   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />

  23.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

  24. 

  25.   </head><body>  

  26. 

  27.     <div class="document">

  28.       <div class="documentwrapper">

  29.         <div class="bodywrapper">

  30.           <div class="body" role="main">

  31.             

  32.   <div class="section" id="administration-api">

  33. <span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>

  34. <div class="section" id="get-configuration-data">

  35. <h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>

  36. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>

  37. </pre></div>

  38. </div>

  39. <div class="section" id="sample-response">

  40. <h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>

  41. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>

  42.   <span class="s2">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>

  43.   <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>

  44.     <span class="s2">&quot;map&quot;</span><span class="p">,</span>

  45.     <span class="s2">&quot;it&quot;</span><span class="p">,</span>

  46.     <span class="s2">&quot;images&quot;</span><span class="p">,</span>

  47.   <span class="p">],</span>

  48.   <span class="s2">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>

  49.   <span class="s2">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s2">&quot;oscar&quot;</span><span class="p">,</span>

  50.   <span class="s2">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>

  51.     <span class="p">{</span>

  52.       <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>

  53.         <span class="s2">&quot;map&quot;</span>

  54.       <span class="p">],</span>

  55.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>

  56.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;openstreetmap&quot;</span><span class="p">,</span>

  57.       <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;osm&quot;</span>

  58.     <span class="p">},</span>

  59.     <span class="p">{</span>

  60.       <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>

  61.         <span class="s2">&quot;it&quot;</span>

  62.       <span class="p">],</span>

  63.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>

  64.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;arch linux wiki&quot;</span><span class="p">,</span>

  65.       <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;al&quot;</span>

  66.     <span class="p">},</span>

  67.     <span class="p">{</span>

  68.       <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>

  69.         <span class="s2">&quot;images&quot;</span>

  70.       <span class="p">],</span>

  71.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>

  72.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;google images&quot;</span><span class="p">,</span>

  73.       <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;goi&quot;</span>

  74.     <span class="p">},</span>

  75.     <span class="p">{</span>

  76.       <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>

  77.         <span class="s2">&quot;it&quot;</span>

  78.       <span class="p">],</span>

  79.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>

  80.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bitbucket&quot;</span><span class="p">,</span>

  81.       <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;bb&quot;</span>

  82.     <span class="p">},</span>

  83.   <span class="p">],</span>

  84.   <span class="s2">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s2">&quot;searx&quot;</span><span class="p">,</span>

  85.   <span class="s2">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>

  86.     <span class="s2">&quot;de&quot;</span><span class="p">:</span> <span class="s2">&quot;Deutsch (German)&quot;</span><span class="p">,</span>

  87.     <span class="s2">&quot;en&quot;</span><span class="p">:</span> <span class="s2">&quot;English&quot;</span><span class="p">,</span>

  88.     <span class="s2">&quot;eo&quot;</span><span class="p">:</span> <span class="s2">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>

  89.   <span class="p">},</span>

  90.   <span class="s2">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>

  91.     <span class="p">{</span>

  92.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>

  93.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;HTTPS rewrite&quot;</span>

  94.     <span class="p">},</span>

  95.     <span class="p">{</span>

  96.       <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>

  97.       <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Vim-like hotkeys&quot;</span>

  98.     <span class="p">}</span>

  99.   <span class="p">],</span>

  100.   <span class="s2">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>

  101. <span class="p">}</span>

  102. </pre></div>

  103. </div>

  104. </div>

  105. </div>

  106. </div>

  107. <div class="section" id="embed-search-bar">

  108. <h1>Embed search bar<a class="headerlink" href="#embed-search-bar" title="Permalink to this headline">¶</a></h1>

  109. <p>The search bar can be embedded into websites. Just paste the example into the HTML of the site.

  110. URL of the searx instance and values are customizable.</p>

  111. <div class="code html highlight-default notranslate"><div class="highlight"><pre><span></span>&lt;form method=&quot;post&quot; action=&quot;https://searx.me/&quot;&gt;

  112.     &lt;!-- search query --&gt; &lt;input type=&quot;text&quot; name=&quot;q&quot; /&gt;

  113.     &lt;!-- categories   --&gt; &lt;input type=&quot;hidden&quot; name=&quot;categories&quot; value=&quot;general,social media&quot; /&gt;

  114.     &lt;!-- language     --&gt; &lt;input type=&quot;hidden&quot; name=&quot;lang&quot; value=&quot;all&quot; /&gt;

  115.     &lt;!-- locale       --&gt; &lt;input type=&quot;hidden&quot; name=&quot;locale&quot; value=&quot;en&quot; /&gt;

  116.     &lt;!-- date filter  --&gt; &lt;input type=&quot;hidden&quot; name=&quot;time_range&quot; value=&quot;month&quot; /&gt;

  117. &lt;/form&gt;

  118. </pre></div>

  119. </div>

  120. </div>

  121. 

  122. 

  123.           </div>

  124.         </div>

  125.       </div>

  126.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  127.         <div class="sphinxsidebarwrapper">

  128.   <h3><a href="../index.html">Table Of Contents</a></h3>

  129.   <ul>

  130. <li><a class="reference internal" href="#">Administration API</a><ul>

  131. <li><a class="reference internal" href="#get-configuration-data">Get configuration data</a><ul>

  132. <li><a class="reference internal" href="#sample-response">Sample response</a></li>

  133. </ul>

  134. </li>

  135. </ul>

  136. </li>

  137. <li><a class="reference internal" href="#embed-search-bar">Embed search bar</a></li>

  138. </ul>

  139. <div class="sidebar_container body">

  140. <h1>Searx</h1>

  141. <ul>

  142.     <li><a href="../index.html">Home</a></li>

  143.     <li><a href="https://github.com/asciimoo/searx">Source</a></li>

  144.     <li><a href="../blog/blog.html">Blog</a></li>

  145.     <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>

  146.     <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>

  147. </ul>

  148. <hr />

  149. <ul>

  150.     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>

  151. </ul>

  152. </div>

  153.   <div role="note" aria-label="source link">

  154.     <h3>This Page</h3>

  155.     <ul class="this-page-menu">

  156.       <li><a href="../_sources/admin/api.rst.txt"

  157.             rel="nofollow">Show Source</a></li>

  158.     </ul>

  159.    </div>

  160. <div id="searchbox" style="display: none" role="search">

  161.   <h3>Quick search</h3>

  162.     <div class="searchformwrapper">

  163.     <form class="search" action="../search.html" method="get">

  164.       <input type="text" name="q" />

  165.       <input type="submit" value="Go" />

  166.       <input type="hidden" name="check_keywords" value="yes" />

  167.       <input type="hidden" name="area" value="default" />

  168.     </form>

  169.     </div>

  170. </div>

  171. <script type="text/javascript">$('#searchbox').show(0);</script>

  172.         </div>

  173.       </div>

  174.       <div class="clearer"></div>

  175.     </div>

  176.     <div class="footer">

  177.       &copy; Copyright 2015-2017, Adam Tauber.

  178.     </div>

  179.   </body>

  180. </html>