Skip to main content

Format an external disk

POST 
/disks/external/:label/format

Required role: admin. Only an account or token with the admin role can call this operation.

Example request
curl --request POST \
  --header "Authorization: Bearer $HOSERVA_TOKEN" \
  --header "Content-Type: application/json" \
  --data @body.json \
  "https://$HOSERVA_HOST:8008/api/v1/disks/external/{label}/format"

Formats the disk after the same typed confirmation array setup uses. The boot device is never offered. A wrong or missing confirmation is refused with confirmation_required and formats nothing. The Unraid USB stick is refused with unraid_stick (409), whatever the confirmation.

Request​

Responses​

The formatted external disk.