Commit 86eb63bc authored by Eugen Rochko's avatar Eugen Rochko

Add domain blocks API

parent c9c516ee
--- ---
title: Domain blocks API title: Domain blocks
menu: menu:
docs: docs:
parent: api parent: rest-api
weight: 10 weight: 10
--- ---
## GET /api/v1/domain_blocks
Domains the user has blocked.
Returns array of string.
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:blocks follow" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `limit` | Maximum number of results | Optional | 40 |
### Pagination
{{< api_pagination >}}
## POST /api/v1/domain_blocks
Block a domain to hide all public posts from it, all notifications from it, and remove all followers from it.
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:blocks follow" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `domain` | Domain to block| Required ||
## DELETE /api/v1/domain_blocks
Remove a domain block.
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:blocks follow" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `domain` | Domain to block| Required ||
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
{{ with .Get "scope" }} {{ with .Get "scope" }}
<tr> <tr>
<th style="text-align: left">Scope</th> <th style="text-align: left">Scope</th>
<td><code>{{.}}</code></td> <td>{{range split . " "}}<code>{{ . }}</code> {{ end }}</td>
</tr> </tr>
{{ end }} {{ end }}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment