Skip to main content
GET
/
api
/
parameters
/
vm
VM parameters
curl --request GET \
  --url https://api.tenbytecloud.com/v1/api/parameters/vm \
  --header 'apikey: <api-key>'
[
  {
    "constraint": "range",
    "description": "Size of main storage in gigabytes.",
    "mandatory": true,
    "max": 240,
    "min": 20,
    "parameter": "disks",
    "type": "integer"
  },
  {
    "constraint": "regexp",
    "description": "Name of the VM",
    "expression": "^[0-9a-zA-Z][-0-9a-zA-Z]{2,}[0-9a-zA-Z]$",
    "mandatory": true,
    "parameter": "name",
    "type": "string"
  },
  {
    "constraint": "enum",
    "description": "OS name of VM base image.",
    "mandatory": true,
    "parameter": "os_name",
    "type": "string",
    "values": [
      "centos",
      "ubuntu",
      "windows",
      "debian"
    ]
  },
  {
    "constraint": "enum",
    "description": "OS version of VM base image.",
    "limited_by": "os_name",
    "mandatory": true,
    "parameter": "os_version",
    "type": "string"
  },
  {
    "constraint": "regexp",
    "description": "Password for logging in to the VM.",
    "expression": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).{8,}$",
    "mandatory": true,
    "parameter": "password",
    "type": "string"
  },
  {
    "constraint": "range",
    "description": "Amount of RAM.",
    "mandatory": true,
    "max": 65536,
    "min": 512,
    "parameter": "ram",
    "type": "integer"
  },
  {
    "constraint": "regexp",
    "description": "Username for logging in to the VM.",
    "mandatory": true,
    "parameter": "username",
    "type": "string"
  },
  {
    "constraint": "range",
    "description": "Number of CPUs.",
    "mandatory": true,
    "max": 16,
    "min": 1,
    "parameter": "vcpu",
    "type": "integer"
  }
]

Authorizations

apikey
string
header
required

Response

200 - application/json

List of VM parameter constraints