For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reinstall your servers

To reinstall your servers, use the endpoint provided in the API documentation. Ensure you obtain the required UUID from the POST /servers response body. You may pass optional parameters such as:

  • name (hostname)

  • os (operating system), which must include a slug property

  • kernelParam (optional)

  • partitions (optional)

  • sshKey (optional). If you leave it out, the keys from the original server request are reinstalled. See SSH keys on reinstall below.

  • postInstallScript (a shell script on Linux, PowerShell on Windows — see Post-install scripts). If omitted, no script runs; the one from the original server request is not carried over.

Usage Scenarios

  • Parameters:

    • name: (string) Optionally include kernelParam, partitions, sshKey

  • Behavior: The originally provisioned OS will be reinstalled, including any specified kernelParam, custom partitions, and/or sshKey.

    • If you pass a new sshKey, it replaces the original. If you leave it out, the original keys are reinstalled.

  • Parameters:

    • os: (object) Fully specify the OS you want to install.

  • Behavior: The originally provisioned OS will be replaced by the provided OS object, which is installed instead.

  • Parameters:

    • sshKey: (array)

  • Behavior: The originally provisioned OS is reinstalled, but only the passed SSH keys are injected (not the default/original ones).

  • Query parameter: ?wipeDisk=false

  • Behavior: The OS is reinstalled, but the explicit quick-format pre-step is skipped.

SSH keys on reinstall

sshKey is optional on a reinstall, whichever operating system you install — including when you switch to a different OS.

What you send decides which keys end up on the reinstalled server:

You send
Result

Nothing, or "sshKey": null

The keys from the original server request are reinstalled

"sshKey": []

Also the original keys — an empty array does not clear them

"sshKey": ["ssh-ed25519 AAAA..."]

Only the keys you pass are installed; the original ones are dropped

Example PATCH request with all of the options

Last updated

Was this helpful?