From fa49da0ecef55b64c31ed53c4e20f77ce3617063 Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Thu, 24 Jul 2025 12:10:42 -0400 Subject: [PATCH] Add placeholder and fix other missing ones --- docs/api/supervisor/endpoints.md | 37 +++++++++++++++++++------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index ba36eb71..c3104805 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -2235,7 +2235,7 @@ Value in `name` must be unique and can only consist of letters, numbers and unde - + Update an existing mount in Supervisor and remount it **Payload:** @@ -2259,12 +2259,12 @@ name, it cannot be changed. Delete and re-add the mount to change the name. - + Unmount and delete an existing mount from Supervisor. - + Unmount and remount an existing mount in Supervisor using the same configuration. @@ -2485,7 +2485,7 @@ Return a list of available [Access Points](api/supervisor/models.md#access-point - + Create a new VLAN *id* on this network interface. @@ -2931,7 +2931,7 @@ Execute a healthcheck and autofix & notifcation. - + Set options for this check. @@ -2943,7 +2943,7 @@ Set options for this check. - + Execute a specific check right now. @@ -3524,13 +3524,20 @@ Update the supervisor Some of the endpoints uses placeholders indicated with `<...>` in the endpoint URL. -| placeholder | description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| 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. | +| placeholder | description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 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. | | application | The name of an application, call `/audio/info` to get the correct name | -| 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 | -| registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` | -| service | The service name for a service on the host. | -| backup | A valid backup slug, example `skuwe823`, to get the slug you can call `/backups` | -| suggestion | A valid suggestion, example `clear_full_backup`, to get the suggestion you can call `/resolution` | -| uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` | +| backup | A valid backup slug, example `skuwe823`, to get the slug you can call `/backups` | +| bootid | An identifier for a specific boot of host system or an integer offset from the current boot. See `/host/logs/boots/` for more details | +| check | The slug for a check in Supervisor's resolution manager, call `/resolution/info` to see the list of options in the `checks` field | +| 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 | +| identifier | A syslog identifier from systemd journal, call `/host/logs/identifiers` to get a complete list of options | +| 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 | +| mount | Name of a mount that exists in Supervisor, call `/mounts` to get a list of options | +| registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` | +| respository | The slug for a respository in Supervisor's add-on store, call `/store/repositories` to get a list of options | +| service | The service name for a service on the host, call `/host/services` to get a list of options | +| suggestion | A valid suggestion, example `clear_full_backup`, to get the suggestion you can call `/resolution` | +| uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` | +| vlan | The id for a vlan network device in network manager on the host. Should be an integer |