Reinstall Server

Start a server re-installation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the server, can be retrieved from the List Servers endpoint.

Body Params
boolean
required
Defaults to true

Set to true for automatic reinstall, set to false for technician reinstall.

string
required

Retrieve valid image ID for server from List Server Reinstall Images endpoint.

string

Defines the disk layout for the installation. Specify a comma-separated list of partition definitions using: mountpoint=size[:filesystem][:drivenumber]

  • mountpoint — Target mount location (e.g., /, /var, /data). Use none to create an unformatted partition.
  • size — Either a size in megabytes (e.g., 102400), a percentage of total disk space (e.g., 50%), or rest to consume remaining space.
  • filesystem (optional) — Defaults to ext3 (ext2 for /boot) if omitted. Supported filesystems include ext2, ext3, ext4, xfs, and jfs. Use none for unformatted partitions.
  • drivenumber (optional) — Target disk number (e.g., 1, 2). Starts at disk 1. If omitted, the primary disk is used.

Examples

  • One Drive Partitions String: /=102400,/var=204800,/data=rest
    • Drive 1 has a 100GB root (/) partition, a 200GB /var partition, and a /data partition using the remainder of the space on the drive, all with ext3 formatting
  • Multiple Drives Partitions String: /=102400:ext4:1,/var=204800:ext4:1,/data=rest:ext4:1,/backup=rest:xfs:2,/tmp=102400:ext4:3,none=rest:none:3
    • Drive 1 has a 100GB root (/) partition, a 200GB /var partition, and a /data partition using the remainder of the space on the drive, all with ext4 formatting
    • Drive 2 has a single /backup partition formatted in XFS using the entire drive
    • Drive 3 has a /tmp partition using 100GB formatted in ext4, with the remainder of the space on the drive in an unformatted partition

Software RAID can be configured using the partitions string with the following format: raid=size:raidlevel:drivenumber,raid=size:raidlevel:drivenumber,mountpoint=rest[:filesystem]:raid

  • size — Functions as before, with rest being the recommended value to consume the full drive for RAID usage
  • drivenumber — Functions as before and is used to indicate which drives are participating in the RAID
  • raidlevel — The requested RAID level. Supported are 1 (mirroring) and 0 (striping)
  • mountpoint — Functions as before, except that raid is used instead of drive number for any partitions intended for the RAID

Examples

  • RAID 1 partitions string: raid=rest:1:1,raid=rest:1:2,/=102400:ext4:raid,/data=rest:xfs:raid
    • RAID 1 has both drives allocated fully with a 100GB root (/) partition formatted with ext4 and the remainder in the /data partition formatted with XFS
  • RAID 0 partitions string: raid=rest:0:1,raid=rest:0:2,/=102400:ext4:raid,/data=rest:xfs:raid
    • RAID 0 has both drives striped with a 100GB root (/) partition formatted with ext4 and the remainder in the /data partition formatted with XFS
boolean

Logical volume manager enabled.

boolean

GUID partition table enabled.

string

Instructions for technician reinstall

Headers
string

TOTP AuthorizationKey. Required if user has enabled 2FA. (i.e. X-Additional-Authorization: Totp XXXXXX)

string
required

Required with Compass API token.
Provide keyword Bearer and space before token.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json