GET /api/v3/templates

Retrieves VM templates and blueprints

GET /api/v3/templates?templateType={0|1}&projectId={projectID}&regionId={regionID}&skip={skip_value}&take={take_value}

Request Payload

None

Parameters

templateType Optional. Filters the results by type of template. Possible values:

  • 0. Returns blueprints only
  • 1. Returns VM templates only

If not specified, the results are not filtered.
projectId Optional. Filters the results to include only blueprints that belong to a specific project, where {projectID} is the ID of the project.
If not specified, the results are not filtered.
regionId Optional. Filters the results to include only templates that belong to a specific region, where {regionID} is the ID of the region.
If not specified the results are not filtered.
skip Optional. Specifies to skip the first {skip_value} records, where {skip_value} is an integer (default: 0). Can be used iteratively in conjunction with take to view distinct sets of template records.
take Optional. Limits the number of records returned, where {take_value} is the maximum number of records to return. Integer (default: 1000, maximum: 1000).

Response Example

[
    {
        "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"
    }
]