Capture a VM as a template

POST

/vm/{rid}/templates

curl --request POST \
  --url https://sylve.lan:8181/api/vm/1/templates \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Validate and queue creation of a VM template from a shut-off source VM without deleting the source VM

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Source Virtual Machine RID

Request Body

Template capture request

Media typeapplication/json

object

name

string

Example^generated

{
  "name": "example"
}

Responses

202

Accepted

Media typeapplication/json

object

data

object

action

string

outcome

string

sourceRid

integer

taskId

integer

error

string

message

string

status

string

Example^generated

{
  "data": {
    "action": "example",
    "outcome": "example",
    "sourceRid": 1,
    "taskId": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}