Server
Server
List servers
Get list of servers
Get server
Get server details
List server credentials
Get credentials for a server
Check if server can start
Whether the server can be started now with `POST /api/v3/servers/{server_id}/power-actions` and `action` `start`. `can_action` is false for a physical server, which only has `reboot`, and for the server of a private cloud; also while the server is not ready, its service is not active or is under maintenance, another operation does not allow the action, or the virtual machine is already running
Check if server can reboot
Whether the server can be rebooted now with `POST /api/v3/servers/{server_id}/power-actions` and `action` `reboot`, the only power action of the physical servers. `can_action` is false for the server of a private cloud, and while the server is not ready, its service is not active or is under maintenance, another operation does not allow the action, the virtual machine is not running, or the physical server cannot be managed at its supplier
Check if server can stop
Whether the server can be stopped now with `POST /api/v3/servers/{server_id}/power-actions` and `action` `stop`. `can_action` is false for a physical server, which only has `reboot`, and for the server of a private cloud; also while the server is not ready, its service is not active or is under maintenance, another operation does not allow the action, or the virtual machine is already stopped
Check if server can hard reboot
Whether the server can be forcibly rebooted now with `POST /api/v3/servers/{server_id}/power-actions` and `action` `hard_reboot`. `can_action` is false for a physical server, which only has `reboot`, and for the server of a private cloud; also while the server is not ready, its service is not active or is under maintenance, another operation does not allow the action, or the virtual machine is not running
Check if server can hard stop
Whether the server can be forcibly stopped now with `POST /api/v3/servers/{server_id}/power-actions` and `action` `hard_stop`. `can_action` is false for a physical server, which only has `reboot`, and for the server of a private cloud; also while the server is not ready, its service is not active or is under maintenance, another operation does not allow the action, or the virtual machine is already stopped
Start, stop or reboot a server
Starts a power action on the server, chosen with `action`; the operation goes on in the background as the returned Task. 403 for an action that the server does not have (physical servers only have `reboot`); 409 while the server is not ready, its service is not active or is under maintenance, or another operation does not allow the action. Before, each action had its own path (`β¦/start`, `β¦/reboot`, `β¦/stop`, `β¦/hard-reboot`, `β¦/hard-stop`)
List server snapshots
Get list of snapshots for server
Get server snapshot
Get snapshot details for server
Delete server snapshot
Delete a server snapshot
Restore server snapshot
Restore a server snapshot
List server backups
Get list of backups for server
Get server backup
Get backup details for server
Restore server backup
Restore a server backup
List server IP addresses
Get list of IP addresses for server
Get server IP address
Get IP address details for server
Delete IP reverse DNS
Delete reverse DNS for an IP address
Update IP reverse DNS
Update reverse DNS for an IP address
Get private cloud info
Get private cloud details for server
List free IP addresses of a private cloud
Free and available IP addresses of the pool of the private cloud, the ones to use as `ip_address_id` to create a VM of the private cloud or a public network interface of one of its VMs. The server can be the private cloud or one of its VMs.
Get automatic snapshot settings
Returns the automatic snapshot of the server (404 if none is configured). Automatic snapshots must be included in the service plan (for a private cloud VM, in the plan of the private cloud), otherwise the response is 403.
Create automatic snapshot settings
Configures the automatic snapshot of the server. A server has at most one automatic snapshot: if one is already configured the response is 409 and the configuration is changed with PATCH. Automatic snapshots must be included in the service plan, otherwise the response is 403.
Delete automatic snapshot settings
Removes the automatic snapshot of the server (404 if none is configured). The snapshots it created that have no expiry date receive the default expiry of the plan.
Update automatic snapshot settings
Replaces the configuration of the automatic snapshot of the server (404 if none is configured). Automatic snapshots must be included in the service plan, otherwise the response is 403.
List exposable server backups
Lists the backups of the server that can be exposed with `POST /api/v3/servers/{server_id}/backups/exhibitions`: the restorable backups visible to the customer, one-off backups included. It does not tell which backup is exposed now
Expose a server backup
Exposes a backup of the virtual machine (`backup_id`, one of `GET /api/v3/servers/{server_id}/backups/exhibitions`) as an additional disk, to read its files without restoring it: it replaces the backup exposed before, the server may restart, and the operation goes on in the background as the returned Task. Exposed backups are removed after a few days, or with `DELETE /api/v3/servers/{server_id}/backups/exhibitions`. 409 for a physical server or a virtual machine that is not on oVirt, while the exposed backups are being deleted, while the server is not ready, its service is not active or is under maintenance, or another operation does not allow it
Delete exposed backups
Removes the backups exposed on the virtual machine with `POST /api/v3/servers/{server_id}/backups/exhibitions`; the operation goes on in the background as the returned Task. 409 while a backup is being exposed, for a physical server or a virtual machine that is not on oVirt, while the server is not ready, its service is not active or is under maintenance, or another operation does not allow it
List server network interfaces
Lists the active network interfaces (VIF) of the server, on public and local networks; the deleted interfaces are not returned
Create server network interface
Starts the creation of a network interface: local, on an active local network of the cluster where the server resides, or public, on an IP address. The creation is asynchronous and is returned as a Task.
Get server network interface
Returns an active network interface (VIF) of the server; a deleted interface responds 404
Delete server network interface
Starts the deletion of an active network interface, returned as a Task. The default interface and the one of the primary IP address cannot be deleted.
Reinstall server
Reinstalls the virtual machine with its current template and operating system: it deletes the virtual machine and its snapshots and creates it again, after a safety backup unless `safety_backup_enabled` is false. The operation goes on in the background as the returned Task. 409 for a physical server, while the server is not ready, its service is not active or is under maintenance, or another operation does not allow it
Create private cloud VM
Create private cloud VM. The response is 409 when the private cloud already has the maximum number of virtual machines, its daily backup space is already in use, it has no licences left for the template, or another operation is in progress.
Delete private cloud VM
Deletes a virtual machine of the private cloud `server_id`, dismissing its purchase; the operation goes on in the background as the returned Task. 404 when the virtual machine is not on the private cloud; 409 when `server_id` is not a private cloud, while the private cloud is not active or is suspended, or while the purchase of the virtual machine cannot be dismissed or another operation does not allow it
Update private cloud VM
Updates the note and the resources of a private cloud VM. The change of cpu, ram or disk starts an asynchronous operation, returned as a Task; when none of them differs from the current value no operation starts and `data` is null.