Per user-limits API documentation

This commit is contained in:
Ayanda-D 2020-07-16 14:57:19 +01:00 committed by Michael Klishin
parent 6018abed6a
commit 8164a97123
1 changed files with 34 additions and 0 deletions

View File

@ -759,6 +759,40 @@ or:
<td class="path">/api/users/<i>user</i>/topic-permissions</td>
<td>A list of all topic permissions for a given user.</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/user-limits</td>
<td>
Lists per-user limits for all users.
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/user-limits/<i>user</i></td>
<td>
Lists per-user limits for a specific user.
</td>
</tr>
<tr>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td class="path">/api/user-limits/<i>user</i>/<i>name</i></td>
<td>
Set or delete per-user limit for <code>user</code>. The <code>name</code> URL path element
refers to the name of the limit (<code>max-connections</code>, <code>max-channels</code>).
Limits are set using a JSON document in the body: <pre>{"value": 100}</pre>. Example
request:</br>
<pre>curl -4u 'guest:guest' -H 'content-type:application/json' -X PUT localhost:15672/api/user-limits/guest/max-connections -d '{"value": 50}'</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>