Version | Parallels REST API

Parallels REST API

SupportDocumentation

Get Versions By Name

get

Retrieve a list of template's versions.

Query parameters

SiteIdinteger · int32Optional

Site ID for which the template with version information will be retrieved (optional)

NamestringOptional

Filter the result by name (optional)

Responses

application/json; api-version=1.0

object[]Optional

RAS Template Versions Available to VDI/RDS/AVD Template Versions

application/json; api-version=1.0

get

GET /api/AVD/Template/Version HTTP/1.1
Host: 
Accept: */*

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-18T19:36:44.774Z",
    "timeLastMod": "2025-04-18T19:36:44.774Z",
    "name": "text",
    "id": 1,
    "templateId": 1,
    "description": "text"
  }
]

Get Versions

get

Retrieve a list of template's versions.

Path parameters

idinteger · int32Required

Template ID

Responses

application/json; api-version=1.0

object[]Optional

RAS Template Versions Available to VDI/RDS/AVD Template Versions

application/json; api-version=1.0

get

GET /api/AVD/Template/{id}/Version HTTP/1.1
Host: 
Accept: */*

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-18T19:36:44.774Z",
    "timeLastMod": "2025-04-18T19:36:44.774Z",
    "name": "text",
    "id": 1,
    "templateId": 1,
    "description": "text"
  }
]

Delete Version

delete

Remove settings of a RAS Template version.

Path parameters

idinteger · int32Required

The ID of a RAS Template

VersionIdinteger · int32Required

The ID of a RAS Template Version

Responses

application/json; api-version=1.0

objectOptional

RAS Template Versions Available to VDI/RDS/AVD Template Versions

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Version/{VersionId} HTTP/1.1
Host: 
Accept: */*

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-18T19:36:44.774Z",
  "timeLastMod": "2025-04-18T19:36:44.774Z",
  "name": "text",
  "id": 1,
  "templateId": 1,
  "description": "text"
}

Update Version

put

Modify properties of a RAS Template version.

Path parameters

idinteger · int32Required

The ID of a RAS Template

VersionIdinteger · int32Required

The ID of a RAS Template Version

Body

newNamestring | nullableOptional

Template version name.

descriptionstring | nullableOptional

Template version description

Responses

application/json; api-version=1.0

put

PUT /api/AVD/Template/{id}/Version/{VersionId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39

{
  "newName": "text",
  "description": "text"
}

No content