dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-05-26 20:34:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: ea20937084

Browse Source
This commit is contained in:
clokep
2021-11-19 19:40:11 +00:00
parent 95d93bf584
commit 99c7645a68
7 changed files with 52 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
develop/usage/administration/admin_api/background_updates.html
+19
View File
@@ -233,6 +233,25 @@ background updates which won't be cancelled once started.</p>
}
</code></pre>
<p>There is also a <code>GET</code> version which returns the <code>enabled</code> state.</p>
<h2 id="run"><a class="header" href="#run">Run</a></h2>
<p>This API schedules a specific background update to run. The job starts immediately after calling the API.</p>
<p>The API is:</p>
<pre><code>POST /_synapse/admin/v1/background_updates/start_job
</code></pre>
<p>with the following body:</p>
<pre><code class="language-json">{
&quot;job_name&quot;: &quot;populate_stats_process_rooms&quot;
}
</code></pre>
<p>The following JSON body parameters are available:</p>
<ul>
<li><code>job_name</code> - A string which job to run. Valid values are:
<ul>
<li><code>populate_stats_process_rooms</code> - Recalculate the stats for all rooms.</li>
<li><code>regenerate_directory</code> - Recalculate the <a href="../../../user_directory.html">user directory</a> if it is stale or out of sync.</li>
</ul>
</li>
</ul>
</main>