Skip to main content

CreateInstanceRequest

Deploy either from an OS image (os) or by restoring a snapshot (snapshot_uuid). The id fields are sent as strings.

hostnamestringrequired
Example: web-01.example.com
locationstringrequired

Location id.

Example: 1
packagestringrequired

Plan (package) id.

Example: 4
osstring

OS image id. Use this or snapshot_uuid.

Example: 7
authstring

password (default) to generate a root password, or the id of an SSH key on the account for key-based auth.

Default value: password
Example: password
snapshot_uuidstring<uuid>

Restore from this snapshot instead of an OS image.

CreateInstanceRequest
{
  "hostname": "web-01.example.com",
  "location": "1",
  "package": "4",
  "os": "7",
  "auth": "password",
  "snapshot_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}