GET /api/v3/envs/actions/getextendedbytoken

Use a sponsored login token to get details of an Environment along with VM information

GET /api/v3/envs/actions/getextendedbytoken?sponsoredLoginToken=123AbCdEf

Request Payload Examples:

None.

Parameters

sponsoredLoginToken The token returned by the sponsored login API

Response examples

{
    "vms": [
        {
            "id": "MC21ZSnJ8GGaxedAgFzO9KJw2",
            "name": "CentOS 5 With KDE2",
            "description": "My VM",
            "statusText": "Running",
            "progress": 100,
            "imageId": "IMKNnQhURlQm865N1IVZsVXw2",
            "os": "Linux",
            "webAccessUrl": null,
            "fqdn": "uvo1t33prksjyu269bq.vm.cld.dev",
            "externalAddress": "127.0.0.1",
            "internalAddresses": [
                "10.160.189.98"
            ],
            "cpuCount": 1,
            "diskSizeGb": 20,
            "memorySizeMb": 1024,
            "username": "root",
            "password": "Lw7oCVM2wk",
            "consoleToken": null
        }
    ],
    "description": "Some Description",
    "blueprintId": "BPBl7djHwvL3IzD_4lOgmPDQ2",
    "blueprintName": "Web Test",
    "policyId": "POA_LXAJbOnUyjPZGgMK9Kdw2",
    "policyName": "On Demand",
    "expirationTime": "Mon, 09 Mar 2015 08:51:13 GMT",
    "invitationAllowed": false,
    "organization": "CloudShare",
    "ownerEmail": "johndoe@cloudshare.com",
    "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
    "projectName": "Phobos",
    "snapshotId": null,
    "snapshotName": null,
    "statusCode": 2,
    "statusText": "Ready",
    "regionId": "REKolD1-ab84YIxODeMGob9A2",
    "name": "Web Test",
    "id": "EN5YTkVIYcD6kL9flyAAYyzg2"
}
Response Property Notes:
expirationTime The end of the Environment’s allocated disk time. The Environment will be deleted at that time.
statusCode
  • 2: Ready
  • 3: Suspended
  • 4: Archived
  • 5: Deleted
  • 7: Taking a Snapshot
  • 8: Preparing
  • 9: Creation Failed