GetEnvironmentState

Returns the status of the specified environment, including details about each machine in the environment.

Request URL

GET  https://use.cloudshare.com/API/v1/Env/GetEnvironmentState?EnvApiId=<id>&UserApiId=<id>&timestamp=<time_t>&HMAC=<signature>

Parameters

EnvApiId The unique id for the environment.
Example: I5ADJ4VCMBTB

Response example

{
    "apiId": "I5ADJ4VCMBTB",
    "campaign": "N/A",
    "description": "asfdad's CloudShare Pro environment",
    "expirationTime": "Thu, 06 Dec 2012 07:43:36 GMT",
    "invitationAllowed": true,
    "licenseValid": "Valid",
    "machines": [
        {
            "apiId": "PVSV2TWQQ2BA",
            "description": "My machine",
            "ip": "69.195.10.100",
            "name": "CentOS 5 With KDE2",
            "password": "Dw0H1QIpVm",
            "progress": -1,
            "status": "Running",
            "username": "root",
            "webAccessUrl": null
        },
        {
            "apiId": "ZFBXNCGNQT4A",
            "description": "My machine",
            "ip": "69.195.10.100",
            "name": "Prod - Windows 7 Pro SP1",
            "password": "Su357SBAwl",
            "progress": -1,
            "status": "Running",
            "username": "administrator",
            "webAccessUrl": null
        }
    ],
    "name": "asfdad's environment",
    "organization": "N/A",
    "owner": "fdsfsdf@saD.COM",
    "package": "N/A",
    "prototype": "asfdad's environment",
    "snapshot": "asfdad's First Snapshot",
    "status": "Running"
}

The response includes details for the environment, as well as details for each machine that is part of the environment.

Details for the environment include: name, expiration date, license status, prototypes, snapshots

Details for the machines include: name, IP address, running status, URL.

Code sample