External/cloud-hypervisor
1
0
Fork 0
mirror of https://github.com/cloud-hypervisor/cloud-hypervisor.git synced 2024-12-22 05:35:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove old --api-socket behavior

Browse Source 
default --api-socket removed in 78f9ddc6be

Signed-off-by: Andrew Consroe <aconz2@gmail.com>
This commit is contained in:
Andrew Consroe 2024-11-05 18:04:03 -06:00 committed by Rob Bradford
parent 8acaeb5c82
commit 1bc74e43f8
1 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api.md
View File

@ -50,17 +50,12 @@ for more details about the API payloads and responses.
#### REST API Location and availability #### REST API Location and availability
The REST API is available as soon as the Cloud Hypervisor binary is started, The REST API, if enabled, is available as soon as the Cloud Hypervisor binary is started,
through a local UNIX socket. through either a local UNIX socket as given in the Cloud Hypervisor option `--api-socket path=...`
By default, it is located at `/run/user/{user ID}/cloud-hypervisor.{Cloud Hypervisor PID}`. or a fd with `--api-socket fd=...`.
For example, if you launched Cloud Hypervisor as user ID 1000 and its PID is
123456, the Cloud Hypervisor REST API will be available at `/run/user/1000/cloud-hypervisor.123456`.
The REST API default URL can be overridden through the Cloud Hypervisor
option `--api-socket`:
``` ```
$ ./target/debug/cloud-hypervisor --api-socket /tmp/cloud-hypervisor.sock $ ./target/debug/cloud-hypervisor --api-socket path=/tmp/cloud-hypervisor.sock
Cloud Hypervisor Guest Cloud Hypervisor Guest
API server: /tmp/cloud-hypervisor.sock API server: /tmp/cloud-hypervisor.sock
vCPUs: 1 vCPUs: 1