2016-07-09 22:32:57 +02:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2017-03-18 23:56:08 +01:00
< title > Administration API — searx 0.11.0 documentation< / title >
2016-07-09 22:32:57 +02:00
< link rel = "stylesheet" href = "../_static/style.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
2017-03-18 23:56:08 +01:00
VERSION: '0.11.0',
2016-07-09 22:32:57 +02:00
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
< / script >
< script type = "text/javascript" src = "../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../_static/doctools.js" > < / script >
2016-11-04 21:56:14 +01:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2017-03-18 23:56:08 +01:00
< link rel = "top" title = "searx 0.11.0 documentation" href = "../index.html" / >
2016-11-04 21:56:14 +01:00
< link rel = "next" title = "How to protect an instance" href = "filtron.html" / >
2016-07-09 22:32:57 +02:00
< link rel = "prev" title = "Installation" href = "../dev/install/installation.html" / >
< link media = "only screen and (max-device-width: 480px)" href = "../_static/small_flask.css" type = "text/css" rel = "stylesheet" / >
< meta name = "viewport" content = "width=device-width, initial-scale=0.9, maximum-scale=0.9" >
< / head >
< body role = "document" >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "administration-api" >
< span id = "adminapi" > < / span > < h1 > Administration API< a class = "headerlink" href = "#administration-api" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "get-configuration-data" >
< h2 > Get configuration data< a class = "headerlink" href = "#get-configuration-data" title = "Permalink to this headline" > ¶< / a > < / h2 >
2016-11-04 21:56:14 +01:00
< 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 >
2016-07-09 22:32:57 +02:00
< / pre > < / div >
< / div >
< div class = "section" id = "sample-response" >
< h3 > Sample response< a class = "headerlink" href = "#sample-response" title = "Permalink to this headline" > ¶< / a > < / h3 >
2016-11-04 21:56:14 +01:00
< div class = "code sh highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< span class = "s2" > " autocomplete" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "s2" > " categories" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "s2" > " map" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " it" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " images" < / span > < span class = "p" > ,< / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " default_locale" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "s2" > " default_theme" < / span > < span class = "p" > :< / span > < span class = "s2" > " oscar" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " engines" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " categories" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "s2" > " map" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > true< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " openstreetmap" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "s2" > " osm" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " categories" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "s2" > " it" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > true< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " arch linux wiki" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "s2" > " al" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " categories" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "s2" > " images" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > true< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " google images" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "s2" > " goi" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " categories" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "s2" > " it" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > false< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " bitbucket" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "s2" > " bb" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " instance_name" < / span > < span class = "p" > :< / span > < span class = "s2" > " searx" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " locales" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< span class = "s2" > " de" < / span > < span class = "p" > :< / span > < span class = "s2" > " Deutsch (German)" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " en" < / span > < span class = "p" > :< / span > < span class = "s2" > " English" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " eo" < / span > < span class = "p" > :< / span > < span class = "s2" > " Esperanto (Esperanto)" < / span > < span class = "p" > ,< / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " plugins" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > true< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " HTTPS rewrite" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " enabled" < / span > < span class = "p" > :< / span > < span class = "n" > false< / span > < span class = "p" > ,< / span >
< span class = "s2" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Vim-like hotkeys" < / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2016-11-04 21:56:14 +01:00
< span class = "s2" > " safe_search" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span >
2016-07-09 22:32:57 +02:00
< span class = "p" > }< / span >
< / pre > < / div >
< / div >
< / div >
< / div >
< / div >
2016-09-06 18:22:37 +02:00
< div class = "section" id = "embed-search-bar" >
< h1 > Embed search bar< a class = "headerlink" href = "#embed-search-bar" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > The search bar can be embedded into websites. Just paste the example into the HTML of the site.
URL of the searx instance and values are customizable.< / p >
< div class = "code html highlight-default" > < div class = "highlight" > < pre > < span > < / span > < form method=" post" action=" https://searx.me/" >
< !-- search query --> < input type=" text" name=" q" />
< !-- categories --> < input type=" hidden" name=" categories" value=" general,social media" />
< !-- language --> < input type=" hidden" name=" lang" value=" all" />
< !-- locale --> < input type=" hidden" name=" locale" value=" en" />
< !-- date filter --> < input type=" hidden" name=" time_range" value=" month" />
< /form>
< / pre > < / div >
< / div >
< / div >
2016-07-09 22:32:57 +02:00
< / div >
< / div >
< / div >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" > < div class = "sidebar_container body" >
< h1 > Searx< / h1 >
< ul >
< li > < a href = "../index.html" > Home< / a > < / li >
< li > < a href = "https://github.com/asciimoo/searx" > Source< / a > < / li >
2017-05-12 22:51:48 +02:00
< li > < a href = "../blog/blog.html" > Blog< / a > < / li >
2016-07-09 22:32:57 +02:00
< li > < a href = "https://github.com/asciimoo/searx/wiki" > Wiki< / a > < / li >
< li > < a href = "https://github.com/asciimoo/searx/wiki/Searx-instances" > Public instances< / a > < / li >
< / ul >
< hr / >
< ul >
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a > < / li >
< li > < a href = "https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software" > Flattr< / a > < / li >
< li > < a href = "https://gratipay.com/searx" > Gratipay< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" >
© Copyright 2015-2016, Adam Tauber.
< / div >
< / body >
< / html >
