ListEnvironmentsWithState

Returns a list of all environments that are available to the user. Details of each environment are returned as well, including the state and a list of machines for each environment.

Request URL

GET  https://use.cloudshare.com/API/v2/Env/ListEnvironmentsWithState?UserApiId=<id>&token=<token>&timestamp=<time>&HMAC=<signature>

Parameters

None.


Response example

{
    "data": [
        {
            "available_actions": {
                "add_vms": true,
                "delete_vm": false,
                "reboot_vm": false,
                "resume_environment": true,
                "revert_environment": true,
                "revert_vm": false,
                "take_snapshot": false
            },
            "blueprint": "Blueprint1",
            "description": "A new linux environment",
            "envId": "LCU0UWSXEMZA",
            "envToken": "f9aHyVG3x_hLyGMBQKTJHg2",
            "environmentPolicy": "CloudShare/PoC (10 days)",
            "expirationTime": "Sat, 06 Apr 2013 07:12:16 GMT",
            "invitationAllowed": true,
            "licenseValid": "Not relevant",
            "name": "Linux2",
            "organization": "CloudShare",
            "owner": "jsmith@company.com",
            "project": " Documentation Project",
            "resources": {
                "cpu_in_use": 0,
                "cpu_qouta": 10,
                "disk_size_in_use_mb": 0,
                "disk_size_qouta_mb": 204800,
                "total_memory_in_use_mb": 0,
                "total_memory_qouta_mb": 10240
            },
            "snapshot": "Initial snapshot",
            "status_code": 2,
            "status_text": "Not ready",
            "view_url": "https://use.cloudshare.com/Ent/Environment.mvc/View/f9aHyVG3x_hLyGMBQKTJHg2",
            "vms": []
        },
        {
            "available_actions": {
                "add_vms": true,
                "delete_vm": true,
                "reboot_vm": false,
                "resume_environment": true,
                "revert_environment": true,
                "revert_vm": true,
                "take_snapshot": false
            },
            "blueprint": "A linux environment",
            "description": "  CloudShare Pro environment",
            "envId": "V0MDPUQHHN1A",
            "envToken": "VQbE1o1IBQK6B633_UFGog2",
            "environmentPolicy": null,
            "expirationTime": "Wed, 18 Dec 2013 22:00:00 GMT",
            "invitationAllowed": true,
            "licenseValid": "Valid",
            "name": "A linux environment",
            "organization": null,
            "owner": "jsmith@company.com",
            "project": null,
            "resources": {
                "cpu_in_use": 2,
                "cpu_qouta": 10,
                "disk_size_in_use_mb": 32768,
                "disk_size_qouta_mb": 307200,
                "total_memory_in_use_mb": 1024,
                "total_memory_qouta_mb": 8192
            },
            "snapshot": "snap1",
            "status_code": 2,
            "status_text": "Not ready",
            "view_url": "https://use.cloudshare.com/Pro/Environment.mvc/View/VQbE1o1IBQK6B633_UFGog2",
            "vms": [
                {
                    "FQDN": null,
                    "IP": null,
                    "description": "OS: Ubuntu 10.04 Server Spec: 16 GB HD / 0.5 GB RAM",
                    "image_url": "https://use.cloudshare.com/ImageHandler.ashx?GyPhdz_F-lBotCNA-kS5MQ2",
                    "name": "Ubuntu 10.04 Server",
                    "os": "Linux",
                    "password": null,
                    "progress": 100,
                    "status_code": 2,
                    "status_text": "Not ready",
                    "url": "https://use.cloudshare.com/Pro/Machine.mvc/Show?machineToken=Xk9EgwQaAYxrdv5MMbFAIQ2",
                    "username": "sysadmin",
                    "vmId": "TY1QYMZHQM4B",
                    "vmToken": "Xk9EgwQaAYxrdv5MMbFAIQ2",
                    "webAccessUrl": null
                },
                {
                    "FQDN": null,
                    "IP": null,
                    "description": "OS: Ubuntu 10.04 Server Spec: 16 GB HD / 0.5 GB RAM",
                    "image_url": "https://use.cloudshare.com/ImageHandler.ashx?GyPhdz_F-lBotCNA-kS5MQ2",
                    "name": "Ubuntu 10.04 Server (1)",
                    "os": "Linux",
                    "password": null,
                    "progress": 100,
                    "status_code": 2,
                    "status_text": "Not ready",
                    "url": "https://use.cloudshare.com/Pro/Machine.mvc/Show?machineToken=3L_yk1QWEHE_FvfZ8zb1pQ2",
                    "username": "sysadmin",
                    "vmId": "EP40Y4W1CDNB",
                    "vmToken": "3L_yk1QWEHE_FvfZ8zb1pQ2",
                    "webAccessUrl": null
                }
            ]
        },
        {
            "available_actions": {
                "add_vms": true,
                "delete_vm": false,
                "reboot_vm": false,
                "resume_environment": true,
                "revert_environment": true,
                "revert_vm": false,
                "take_snapshot": false
            },
            "blueprint": "linux environment",
            "description": "A new linux environment",
            "envId": "VJ1DWJYN5GXB",
            "envToken": "9wtGldOX2PVXHaUlrTRG2g2",
            "environmentPolicy": "CloudShare/PoC (10 days)",
            "expirationTime": "Thu, 04 Apr 2013 09:55:44 GMT",
            "invitationAllowed": true,
            "licenseValid": "Not relevant",
            "name": "Linux2",
            "organization": "CloudShare",
            "owner": "jsmith@company.com",
            "project": " Documentation Project",
            "resources": {
                "cpu_in_use": 0,
                "cpu_qouta": 10,
                "disk_size_in_use_mb": 0,
                "disk_size_qouta_mb": 204800,
                "total_memory_in_use_mb": 0,
                "total_memory_qouta_mb": 10240
            },
            "snapshot": "Initial State Snapshot",
            "status_code": 2,
            "status_text": "Not ready",
            "view_url": "https://use.cloudshare.com/Ent/Environment.mvc/View/9wtGldOX2PVXHaUlrTRG2g2",
            "vms": []
        },
        {
            "available_actions": {
                "add_vms": true,
                "delete_vm": false,
                "reboot_vm": false,
                "resume_environment": true,
                "revert_environment": true,
                "revert_vm": false,
                "take_snapshot": false
            },
            "blueprint": "linux environment",
            "description": "A new linux environment",
            "envId": "P400PXZJOWEB",
            "envToken": "9FgUl7qx5--BByJ3sEholw2",
            "environmentPolicy": "CloudShare/PoC (10 days)",
            "expirationTime": "Thu, 04 Apr 2013 10:05:53 GMT",
            "invitationAllowed": true,
            "licenseValid": "Not relevant",
            "name": "Linux2",
            "organization": "CloudShare",
            "owner": "jsmith@company.com",
            "project": " Documentation Project",
            "resources": {
                "cpu_in_use": 0,
                "cpu_qouta": 10,
                "disk_size_in_use_mb": 0,
                "disk_size_qouta_mb": 204800,
                "total_memory_in_use_mb": 0,
                "total_memory_qouta_mb": 10240
            },
            "snapshot": "Initial State Snapshot",
            "status_code": 2,
            "status_text": "Not ready",
            "view_url": "https://use.cloudshare.com/Ent/Environment.mvc/View/9FgUl7qx5--BByJ3sEholw2",
            "vms": []
        },
        {
            "available_actions": {
                "add_vms": true,
                "delete_vm": true,
                "reboot_vm": false,
                "resume_environment": true,
                "revert_environment": true,
                "revert_vm": true,
                "take_snapshot": false
            },
            "blueprint": "Linux2",
            "description": "A new linux environment",
            "envId": "HA0VLW3GJ0PA",
            "envToken": "Gh5wSR5wN2nm7I6orvTcDg2",
            "environmentPolicy": "CloudShare/PoC (10 days)",
            "expirationTime": "Thu, 04 Apr 2013 08:37:32 GMT",
            "invitationAllowed": true,
            "licenseValid": "Not relevant",
            "name": "Linux2",
            "organization": "CloudShare",
            "owner": "jsmith@company.com",
            "project": " Documentation Project",
            "resources": {
                "cpu_in_use": 1,
                "cpu_qouta": 10,
                "disk_size_in_use_mb": 12288,
                "disk_size_qouta_mb": 204800,
                "total_memory_in_use_mb": 1024,
                "total_memory_qouta_mb": 10240
            },
            "snapshot": "Initial snapshot",
            "status_code": 2,
            "status_text": "Not ready",
            "view_url": "https://use.cloudshare.com/Ent/Environment.mvc/View/Gh5wSR5wN2nm7I6orvTcDg2",
            "vms": [
                {
                    "FQDN": null,
                    "IP": null,
                    "description": "OS: CentOS 5 Spec: 12 GB HD / 1 GB RAM Installed: MySQL ",
                    "image_url": "https://use.cloudshare.com/ImageHandler.ashx?zsjkKbLQqcJ1PLTNRN2o4w2",
                    "name": "CentOS 5 W/ MySQL",
                    "os": "Linux",
                    "password": null,
                    "progress": 100,
                    "status_code": 2,
                    "status_text": "Not ready",
                    "url": "https://use.cloudshare.com/Ent/Machine.mvc/Show?machineToken=03kPsIRWu58N-nIGEtOahw2",
                    "username": null,
                    "vmId": "ZN3OZ4Z3VE2B",
                    "vmToken": "03kPsIRWu58N-nIGEtOahw2",
                    "webAccessUrl": null
                }
            ]
        }
    ],
    "remaining__calls": 99985,
    "status_additional_data": null,
    "status_code": "0x20000",
    "status_text": "Success"
}