... | ... | @@ -1692,7 +1692,7 @@ https://<hostname>/api/<endpoint> |
|
|
|
|
|
## Preferences
|
|
|
|
|
|
|
|
|
TBD
|
|
|
|
|
|
|
|
|
## Topologie
|
... | ... | @@ -2906,8 +2906,154 @@ https://<hostname>/api/<endpoint> |
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
# DNS-specific endpoints
|
|
|
|
|
|
<details><summary><b>/dns/zones/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all extensions </th>
|
|
|
<th> Retrieve all the informations for each dns zone at once </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
# DHCP-specific endpoints
|
|
|
|
|
|
<details><summary><b>/dhcp/hostmacip/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all interfaces </th>
|
|
|
<th> Retrieve all the host-mac-ip associations for the dhcp at once </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
# Mailing-specific endpoints
|
|
|
|
|
|
<details><summary><b>/mailing/standard/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all users </th>
|
|
|
<th> Retrieve all the informations (name + members) for all standard mailings </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/mailing/club/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all users </th>
|
|
|
<th> Retrieve all the informations (name + members + admins) for all club mailings </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
# Other endpoints
|
|
|
|
|
|
<details><summary><b>/services/regen/</b></summary>
|
|
|
<table>
|
|
|
<tr><th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all serviceslinks </th>
|
|
|
<th> Get the regen status of the services </th>
|
|
|
<th> (optional) hostname=<string> </th>
|
|
|
<th> N/A </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/services/regen/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all serviceslinks <br \>
|
|
|
- Can view this serviceslink </th>
|
|
|
<th> Get the regen status of this service </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th> PATCH </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can edit this whitelist </th>
|
|
|
<th> Set the need_regen status </th>
|
|
|
<th> N/A </th>
|
|
|
<th> need_regen=<boolean> </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/token-auth/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> POST </th>
|
|
|
<th> N/A </th>
|
|
|
<th> Returns a token if credentials are ok </th>
|
|
|
<th> N/A </th>
|
|
|
<th> username=<string> <br />
|
|
|
password=<string> </th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details> |