put_storage_disk_id_format
Format a disk by ID, erasing all data and creating a single partition using the full disk space. Monitor progress via the disk's operation_pct field.
Instructions
Format the disk with the given id To be able to format a disk you need to provide the following parameters (JSON encoded). There will be one partition using all the available space on disk. All previous data will be lost. This parameters will be ignored if you format the Freebox internal disk NOTE: once started you can monitor the format process getting the disk information (see StorageDisk operation_pct field)
Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | (Path parameter) | |
| id | No | the disk id | |
| type | No | Values: `internal`: Freebox internal disk; `usb`: usb disk; `sata`: sata disk | |
| state | No | Values: `error`: Disk has error; `disabled`: Disk is disabled; `enabled`: Disk is enabled; `formatting`: Disk is formatting | |
| connector | No | Disk physical connector id | |
| total_bytes | No | Disk size (in bytes) | |
| table_type | No | ||
| model | No | Disk model | |
| serial | No | Disk serial number | |
| firmware | No | Disk firmware version | |
| temp | No | Disk temperature (when supported) in °C | |
| operation_pct | No | partition operation progress | |
| partitions | No | list of disk partitions | |
| idle | No | is disk idle (when available) | |
| idle_duration | No | disk idle duration (in seconds) (when available) | |
| spinning | No | is disk spinning (when available) | |
| active_duration | No | disk activity duration (in seconds) (when available) | |
| time_before_spindown | No | seconds left before disk spin down (in seconds) (when available) |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||