GET /api/v3/templates

List Template VMs and Blueprints.

GET /api/v3/templates?templateType=1&projectId=PR123ABC&skip=0&take=2

Request Payload Examples:

None.

Parameters

templateType Enumeration of values:

  • Blueprint = 0
  • VM = 1
  • Filter the results to output only VM Templates or only Blueprints.
    Optional. If not specified the results are not filtered.

projectId Filter the results to output only Blueprints that belong to a specific Project.
Optional. If not specified the results are not filtered.
regionId Filter the results to output only Templates that belong to a specific Region.
Optional. If not specified the results are not filtered.
skip and take Skip skip results and output up to take results.
Optional. If not specified all results are outputted.

Response examples

[
    {
        "name": "Template VM 1",
        "description": "My VM",
        "isEnvironmentTemplate": true,
        "type": 1,
        "imageUrl": "/ImageHandler.ashx?rXL5DH0iKAm9EtYscPdMAw2",
        "regionId": "REKolD1-ab84YIxODeMGob9A2",
        "tags": [
            ""
        ],
        "categories": [
            "automation"
        ],
        "resources": {
            "cpuCount": 1,
            "diskSizeMB": 12288,
            "memorySizeMB": 512
        },
        "numberOfMachines": 1,
        "hasMultipleVersions": false,
        "hasDefaultVersion": true,
        "disabledForRegularEnvironmentCreation": null,
        "disabledForTrainingEnvironmentCreation": null,
        "canAddMultipleInstances": true,
        "envTemplateScope": null,
        "creationDate": "Wed, 15 Feb 2012 10:04:51 GMT",
        "id": "VMyFyls16PYN0dZRUfYIqskA2"
    },
    {
        "name": "Template VM 2",
        "description": "My VM",
        "isEnvironmentTemplate": true,
        "type": 1,
        "imageUrl": "/ImageHandler.ashx?1YTwBlG87xLZFAtVPBGN_Q2",
        "regionId": "REKolD1-ab84YIxODeMGob9A2",
        "tags": null,
        "categories": [
            "automation"
        ],
        "resources": {
            "cpuCount": 1,
            "diskSizeMB": 12288,
            "memorySizeMB": 512
        },
        "numberOfMachines": 1,
        "hasMultipleVersions": false,
        "hasDefaultVersion": true,
        "disabledForRegularEnvironmentCreation": null,
        "disabledForTrainingEnvironmentCreation": null,
        "canAddMultipleInstances": true,
        "envTemplateScope": null,
        "creationDate": "Wed, 17 Nov 2010 11:32:15 GMT",
        "id": "VMz08ewmUVWw4CWxjTWE7bxQ2"
    }
]