<!DOCTYPE html>
< html lang = "en" data-content_root = "../" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< title > Administration API — SearXNG Documentation (2025.2.9+a1e2b2546)< / title >
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css?v=6625fa76" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/searxng.css?v=52e4ff28" / >
< script src = "../_static/documentation_options.js?v=09da0b18" > < / script >
< script src = "../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script data-project = "searxng" data-version = "2025.2.9+a1e2b2546" src = "../_static/describe_version.js?v=fa7f30d0" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Architecture" href = "architecture.html" / >
< link rel = "prev" title = "Limiter" href = "searx.limiter.html" / >
< / head > < body >
< div class = "related" role = "navigation" aria-label = "Related" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey = "I" > index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
> modules< / a > |< / li >
< li class = "right" >
< a href = "architecture.html" title = "Architecture"
accesskey = "N" > next< / a > |< / li >
< li class = "right" >
< a href = "searx.limiter.html" title = "Limiter"
accesskey = "P" > previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > SearXNG Documentation (2025.2.9+a1e2b2546)< / a > » < / li >
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Administrator documentation< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Administration API< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section id = "administration-api" >
< span id = "adminapi" > < / span > < h1 > Administration API< a class = "headerlink" href = "#administration-api" title = "Link to this heading" > ¶< / a > < / h1 >
< section id = "get-configuration-data" >
< h2 > Get configuration data< a class = "headerlink" href = "#get-configuration-data" title = "Link to this heading" > ¶< / a > < / h2 >
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nf" > GET< / span > < span class = "nn" > /config< / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span >
< / pre > < / div >
< / div >
< section id = "sample-response" >
< h3 > Sample response< a class = "headerlink" href = "#sample-response" title = "Link to this heading" > ¶< / a > < / h3 >
< div class = "highlight-json notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " autocomplete" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " categories" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "s2" > " map" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "s2" > " it" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "s2" > " images" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " default_locale" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " default_theme" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " simple" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " engines" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " categories" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "s2" > " map" < / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " openstreetmap" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " osm" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " categories" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "s2" > " it" < / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " arch linux wiki" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " al" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " categories" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "s2" > " images" < / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " google images" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " goi" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " categories" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "s2" > " it" < / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " bitbucket" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " shortcut" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " bb" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " instance_name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " searx" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " locales" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " de" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Deutsch (German)" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " en" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " English" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " eo" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Esperanto (Esperanto)" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " plugins" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " enabled" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " HTTPS rewrite" < / span >
< span class = "w" > < / span > < span class = "p" > }< / span >
< span class = "w" > < / span > < span class = "p" > ],< / span >
< span class = "w" > < / span > < span class = "nt" > " safe_search" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 0< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / div >
< / section >
< / section >
< section id = "embed-search-bar" >
< h2 > Embed search bar< a class = "headerlink" href = "#embed-search-bar" title = "Link to this heading" > ¶< / a > < / h2 >
< p > The search bar can be embedded into websites. Just paste the example into the
HTML of the site. URL of the SearXNG instance and values are customizable.< / p >
< div class = "highlight-html notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > < < / span > < span class = "nt" > form< / span > < span class = "na" > method< / span > < span class = "o" > =< / span > < span class = "s" > " post" < / span > < span class = "na" > action< / span > < span class = "o" > =< / span > < span class = "s" > " https://example.org/" < / span > < span class = "p" > > < / span >
< span class = "cm" > < !-- search --> < / span > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " text" < / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " q" < / span > < span class = "p" > > < / span >
< span class = "cm" > < !-- categories --> < / span > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " hidden" < / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " categories" < / span > < span class = "na" > value< / span > < span class = "o" > =< / span > < span class = "s" > " general,social media" < / span > < span class = "p" > > < / span >
< span class = "cm" > < !-- language --> < / span > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " hidden" < / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " lang" < / span > < span class = "na" > value< / span > < span class = "o" > =< / span > < span class = "s" > " all" < / span > < span class = "p" > > < / span >
< span class = "cm" > < !-- locale --> < / span > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " hidden" < / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " locale" < / span > < span class = "na" > value< / span > < span class = "o" > =< / span > < span class = "s" > " en" < / span > < span class = "p" > > < / span >
< span class = "cm" > < !-- date filter --> < / span > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " hidden" < / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " time_range" < / span > < span class = "na" > value< / span > < span class = "o" > =< / span > < span class = "s" > " month" < / span > < span class = "p" > > < / span >
< span class = "p" > < /< / span > < span class = "nt" > form< / span > < span class = "p" > > < / span >
< / pre > < / div >
< / div >
< / section >
< / section >
< div class = "clearer" > < / div >
< / div >
< / div >
< / div >
< span id = "sidebar-top" > < / span >
< div class = "sphinxsidebar" role = "navigation" aria-label = "Main" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/searxng-wordmark.svg" alt = "Logo of SearXNG" / >
< / a > < / p >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "../user/index.html" > User information< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../own-instance.html" > Why use a private instance?< / a > < / li >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "index.html" > Administrator documentation< / a > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings/index.html" > Settings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation.html" > Installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-docker.html" > Docker Container< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-scripts.html" > Installation Script< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-searxng.html" > Step by step installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-uwsgi.html" > uWSGI< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-nginx.html" > NGINX< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-apache.html" > Apache< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "update-searxng.html" > SearXNG maintenance< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "answer-captcha.html" > Answer CAPTCHA from server’ < / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "searx.favicons.html" > Favicons< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "searx.limiter.html" > Limiter< / a > < / li >
< li class = "toctree-l2 current" > < a class = "current reference internal" href = "#" > Administration API< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#get-configuration-data" > Get configuration data< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "#sample-response" > Sample response< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#embed-search-bar" > Embed search bar< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "architecture.html" > Architecture< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "plugins.html" > List of plugins< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "buildhosts.html" > Buildhosts< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../dev/index.html" > Developer documentation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../utils/index.html" > DevOps tooling box< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../src/index.html" > Source-Code< / a > < / li >
< / ul >
< h3 > Project Links< / h3 >
< ul >
< li > < a href = "https://github.com/searxng/searxng/tree/master" > Source< / a >
< li > < a href = "https://github.com/searxng/searxng/wiki" > Wiki< / a >
< li > < a href = "https://searx.space" > Public instances< / a >
< li > < a href = "https://github.com/searxng/searxng/issues" > Issue Tracker< / a >
< / ul > < h3 > Navigation< / h3 >
< ul >
< li > < a href = "../index.html" > Overview< / a >
< ul >
< li > < a href = "index.html" > Administrator documentation< / a >
< ul >
< li > Previous: < a href = "searx.limiter.html" title = "previous chapter" > Limiter< / a >
< li > Next: < a href = "architecture.html" title = "next chapter" > Architecture< / a > < / ul >
< / li >
< / ul >
< / li >
< / ul >
< search id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / search >
< script > document . getElementById ( 'searchbox' ) . style . display = "block" < / script >
< div role = "note" aria-label = "source link" >
< h3 > This Page< / h3 >
< ul class = "this-page-menu" >
< li > < a href = "../_sources/admin/api.rst.txt"
rel = "nofollow" > Show Source< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright SearXNG team.
< / div >
< / body >
< / html >