
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>GET /rest/db/file &#8212; Syncthing v1 documentation</title>
    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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>
    <script type="text/javascript" src="../_static/language_data.js"></script>
    <link rel="shortcut icon" href="../_static/favicon.png"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="GET /rest/db/ignores" href="db-ignores-get.html" />
    <link rel="prev" title="GET /rest/db/completion" href="db-completion-get.html" />
   
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="get-rest-db-file">
<h1>GET /rest/db/file<a class="headerlink" href="#get-rest-db-file" title="Permalink to this headline">¶</a></h1>
<p>Returns most data available about a given file, including version and
availability. Takes <code class="docutils literal notranslate"><span class="pre">folder</span></code> and <code class="docutils literal notranslate"><span class="pre">file</span></code> parameters.</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="nt">&quot;availability&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;ITZRNXE-YNROGBZ-HXTH5P7-VK5NYE5-QHRQGE2-7JQ6VNJ-KZUEDIU-5PPR5AM&quot;</span><span class="p">,</span>
      <span class="nt">&quot;fromTemporary&quot;</span><span class="p">:</span> <span class="kc">false</span>
    <span class="p">}</span>
  <span class="p">],</span>
  <span class="nt">&quot;global&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="nt">&quot;deleted&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;ignored&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;invalid&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;localFlags&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
    <span class="nt">&quot;modified&quot;</span><span class="p">:</span> <span class="s2">&quot;2018-08-18T12:21:13.836784059+02:00&quot;</span><span class="p">,</span>
    <span class="nt">&quot;modifiedBy&quot;</span><span class="p">:</span> <span class="s2">&quot;SYNO4VL&quot;</span><span class="p">,</span>
    <span class="nt">&quot;mustRescan&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;testfile&quot;</span><span class="p">,</span>
    <span class="nt">&quot;noPermissions&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;numBlocks&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
    <span class="nt">&quot;permissions&quot;</span><span class="p">:</span> <span class="s2">&quot;0755&quot;</span><span class="p">,</span>
    <span class="nt">&quot;sequence&quot;</span><span class="p">:</span> <span class="mi">107499</span><span class="p">,</span>
    <span class="nt">&quot;size&quot;</span><span class="p">:</span> <span class="mi">1234</span><span class="p">,</span>
    <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
    <span class="nt">&quot;version&quot;</span><span class="p">:</span> <span class="p">[</span>
      <span class="s2">&quot;SYNO4VL:1&quot;</span>
    <span class="p">]</span>
  <span class="p">},</span>
  <span class="nt">&quot;local&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="nt">&quot;deleted&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;ignored&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;invalid&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;localFlags&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
    <span class="nt">&quot;modified&quot;</span><span class="p">:</span> <span class="s2">&quot;2018-08-18T12:21:13.836784059+02:00&quot;</span><span class="p">,</span>
    <span class="nt">&quot;modifiedBy&quot;</span><span class="p">:</span> <span class="s2">&quot;SYNO4VL&quot;</span><span class="p">,</span>
    <span class="nt">&quot;mustRescan&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;testfile&quot;</span><span class="p">,</span>
    <span class="nt">&quot;noPermissions&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
    <span class="nt">&quot;numBlocks&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
    <span class="nt">&quot;permissions&quot;</span><span class="p">:</span> <span class="s2">&quot;0755&quot;</span><span class="p">,</span>
    <span class="nt">&quot;sequence&quot;</span><span class="p">:</span> <span class="mi">111038</span><span class="p">,</span>
    <span class="nt">&quot;size&quot;</span><span class="p">:</span> <span class="mi">1234</span><span class="p">,</span>
    <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
    <span class="nt">&quot;version&quot;</span><span class="p">:</span> <span class="p">[</span>
      <span class="s2">&quot;SYNO4VL:1&quot;</span>
    <span class="p">]</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>


          </div>
<div class="body footer-body" role="footer">
    <a class="reference external" href="https://github.com/syncthing/docs/edit/master/rest/db-file-get.rst" rel="nofollow">Edit this page on GitHub</a>
</div>

          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<p class="logo">
  <a href="../index.html">
    <img class="logo" src="../_static/logo-horizontal.svg" alt="Logo"/>
    
  </a>
</p>






<p>
<iframe src="https://ghbtns.com/github-btn.html?user=syncthing&repo=syncthing&type=star&count=true&size=large&v=2"
  allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>





<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users/index.html">Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../dev/index.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/web.html">Working on the Web GUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/building.html">Building Syncthing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/contributing.html">Contribution Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/debugging.html">Debugging Syncthing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/crashrep.html">Automatic Crash Reporting for Developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/device-ids.html">Understanding Device IDs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/infrastructure.html">Syncthing Infrastructure</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/issues.html">Issue Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/release-creation.html">Creating a Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/release-signing.html">Release Signing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../dev/rest.html">REST API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/events.html">Event API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../specs/index.html">Specifications</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../index.html">Documentation overview</a><ul>
  <li><a href="../dev/index.html">Development</a><ul>
  <li><a href="../dev/rest.html">REST API</a><ul>
      <li>Previous: <a href="db-completion-get.html" title="previous chapter">GET /rest/db/completion</a></li>
      <li>Next: <a href="db-ignores-get.html" title="next chapter">GET /rest/db/ignores</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div 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" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>


<h3 class="donation">Donate/support</h3>



<p>
<a class="badge" href="https://syncthing.net/donations/">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate">
</a>
</p>





        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      
      
    </div>

    

    
  </body>
</html>