Skip to content
SYLVE

Create VMs from a template

POST
/vm/templates/{templateId}/vms
curl --request POST \
  --url https://sylve.lan:8181/api/vm/templates/1/vms \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cloudInitPrefix": "example", "count": 1, "mode": "example", "name": "example", "namePrefix": "example", "rewriteCloudInitIdentity": true, "rid": 1, "startRid": 1, "storagePools": [ { "pool": "example", "sourceStorageId": 1 } ] }'

Validate and queue creation of one or more virtual machines from a VM template

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
templateId
required
integer
>= 1

VM Template ID

Request Body

Section titled “Request Body”

VM template instantiation request

Media typeapplication/json
object
cloudInitPrefix
string
count
integer
mode
string
name
string
namePrefix
string
rewriteCloudInitIdentity
boolean
rid
integer
startRid
integer
storagePools
Array<object>
object
pool
string
sourceStorageId
integer
Examplegenerated
{
  "cloudInitPrefix": "example",
  "count": 1,
  "mode": "example",
  "name": "example",
  "namePrefix": "example",
  "rewriteCloudInitIdentity": true,
  "rid": 1,
  "startRid": 1,
  "storagePools": [
    {
      "pool": "example",
      "sourceStorageId": 1
    }
  ]
}

Responses

Section titled “Responses”

202

Section titled “202”

Accepted

Media typeapplication/json
object
data
object
action
string
outcome
string
taskId
integer
templateId
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "action": "example",
    "outcome": "example",
    "taskId": 1,
    "templateId": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}