Skip to content

Commit 5aad8bf

Browse files
mdegat01mdegat01
committed
Add placeholder and fix other missing ones
1 parent 4bf1816 commit 5aad8bf

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

‎docs/api/supervisor/endpoints.md‎

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2235,7 +2235,7 @@ Value in `name` must be unique and can only consist of letters, numbers and unde
22352235

22362236
</ApiEndpoint>
22372237

2238-
<ApiEndpoint path="/mounts/<name>" method="put">
2238+
<ApiEndpoint path="/mounts/<mount>" method="put">
22392239
Update an existing mount in Supervisor and remount it
22402240

22412241
**Payload:**
@@ -2259,12 +2259,12 @@ name, it cannot be changed. Delete and re-add the mount to change the name.
22592259

22602260
</ApiEndpoint>
22612261

2262-
<ApiEndpoint path="/mounts/<name>" method="delete">
2262+
<ApiEndpoint path="/mounts/<mount>" method="delete">
22632263
Unmount and delete an existing mount from Supervisor.
22642264

22652265
</ApiEndpoint>
22662266

2267-
<ApiEndpoint path="/mounts/<name>/reload" method="post">
2267+
<ApiEndpoint path="/mounts/<mount>/reload" method="post">
22682268
Unmount and remount an existing mount in Supervisor using the same configuration.
22692269

22702270
</ApiEndpoint>
@@ -2485,7 +2485,7 @@ Return a list of available [Access Points](api/supervisor/models.md#access-point
24852485

24862486
</ApiEndpoint>
24872487

2488-
<ApiEndpoint path="/network/interface/<interface>/vlan/<id>" method="post">
2488+
<ApiEndpoint path="/network/interface/<interface>/vlan/<vlan>" method="post">
24892489

24902490
Create a new VLAN *id* on this network interface.
24912491

@@ -2931,7 +2931,7 @@ Execute a healthcheck and autofix & notifcation.
29312931

29322932
</ApiEndpoint>
29332933

2934-
<ApiEndpoint path="/resolution/check/<slug>/options" method="post">
2934+
<ApiEndpoint path="/resolution/check/<check>/options" method="post">
29352935

29362936
Set options for this check.
29372937

@@ -2943,7 +2943,7 @@ Set options for this check.
29432943

29442944
</ApiEndpoint>
29452945

2946-
<ApiEndpoint path="/resolution/check/<slug>/run" method="post">
2946+
<ApiEndpoint path="/resolution/check/<check>/run" method="post">
29472947

29482948
Execute a specific check right now.
29492949

@@ -3524,13 +3524,20 @@ Update the supervisor
35243524

35253525
Some of the endpoints uses placeholders indicated with `<...>` in the endpoint URL.
35263526

3527-
| placeholder | description |
3528-
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
3529-
| addon | The slug for the addon, to get the slug you can call `/addons`, to call endpoints for the add-on calling the endpoints you can use `self`as the slug. |
3527+
| placeholder | description |
3528+
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
3529+
| addon | The slug for the addon, to get the slug you can call `/addons`, to call endpoints for the add-on calling the endpoints you can use `self` as the slug. |
35303530
| application | The name of an application, call `/audio/info` to get the correct name |
3531-
| interface | A valid interface name, example `eth0`, to get the interface name you can call `/network/info`. You can use `default` to get the primary interface |
3532-
| registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` |
3533-
| service | The service name for a service on the host. |
3534-
| backup | A valid backup slug, example `skuwe823`, to get the slug you can call `/backups` |
3535-
| suggestion | A valid suggestion, example `clear_full_backup`, to get the suggestion you can call `/resolution` |
3536-
| uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` |
3531+
| backup | A valid backup slug, example `skuwe823`, to get the slug you can call `/backups` |
3532+
| bootid | An identifier for a specific boot of host system or an integer offset from the current boot. See `/host/logs/boots/<bootid>` for more details |
3533+
| check | The slug for a check in Supervisor's resolution manager, call `/resolution/info` to see the list of options in the `checks` field |
3534+
| device | A UUID or device path for an NVMe device available on the host, call `/host/info` to get a list of options in the `nvme_devices` field |
3535+
| identifier | A syslog identifier from systemd journal, call `/host/logs/identifiers` to get a complete list of options |
3536+
| interface | A valid interface name, example `eth0`, to get the interface name you can call `/network/info`. You can use `default` to get the primary interface |
3537+
| mount | Name of a mount that exists in Supervisor, call `/mounts` to get a list of options |
3538+
| registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` |
3539+
| respository | The slug for a respository in Supervisor's add-on store, call `/store/repositories` to get a list of options |
3540+
| service | The service name for a service on the host, call `/host/services` to get a list of options |
3541+
| suggestion | A valid suggestion, example `clear_full_backup`, to get the suggestion you can call `/resolution` |
3542+
| uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` |
3543+
| vlan | The id for a vlan network device in network manager on the host. Should be an integer |

0 commit comments

Comments
 (0)