free
/
searx
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 11 Wiki Activity
78 Commits
10 Branches
Tree: 08050d9e71
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '08050d9e71'
${ noResults }
searx/admin/api.html

api.html 9.2KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 
  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="Content-Type" content="text/html; charset=utf-8" />

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

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

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

  11.     <script type="text/javascript">

  12.       var DOCUMENTATION_OPTIONS = {

  13.         URL_ROOT:    '../',

  14.         VERSION:     '0.12.0',

  15.         COLLAPSE_INDEX: false,

  16.         FILE_SUFFIX: '.html',

  17.         HAS_SOURCE:  true,

  18.         SOURCELINK_SUFFIX: '.txt'

  19.       };

  20.     </script>

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

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

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

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

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

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

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

  28.    

  29.   

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

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

  32. 

  33.   </head>

  34.   <body>  

  35. 

  36.     <div class="document">

  37.       <div class="documentwrapper">

  38.         <div class="bodywrapper">

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

  40.             

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

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

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

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

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

  46. </pre></div>

  47. </div>

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

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

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

  51.   <span class="s2">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><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><span class="p">,</span>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  111. </pre></div>

  112. </div>

  113. </div>

  114. </div>

  115. </div>

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

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

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

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

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

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

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

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

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

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

  126. &lt;/form&gt;

  127. </pre></div>

  128. </div>

  129. </div>

  130. 

  131. 

  132.           </div>

  133.         </div>

  134.       </div>

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

  136.         <div class="sphinxsidebarwrapper"><div class="sidebar_container body">

  137. <h1>Searx</h1>

  138. <ul>

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

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

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

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

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

  144. </ul>

  145. <hr />

  146. <ul>

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

  148. </ul>

  149. </div>

  150.         </div>

  151.       </div>

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

  153.     </div>

  154.     <div class="footer">

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

  156.     </div>

  157.   </body>

  158. </html>