Skip to main content
POST
/
v1
/
regions
/
{region}
/
compute
/
vms
Create VM
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    machineType: '<string>',
    image: '<string>',
    networkId: '<string>',
    sshKeyId: '<string>',
    metadata: {}
  })
};

fetch('https://api.example.com/v1/regions/{region}/compute/vms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "creating",
    "machineType": "<string>",
    "image": "<string>",
    "networkId": "<string>",
    "ipAddress": "<string>",
    "sshKeyId": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

region
string
required

Region identifier

Body

application/json
name
string
required
machineType
string
required
image
string
required
networkId
string | null
sshKeyId
string | null
metadata
object

Response

201 - application/json

VM created

success
enum<boolean>
Available options:
true
data
object

Virtual machine