GET /api/v3/envs/actions/getmultipleenvsresources

Retrieves all environments that were active in a specified time range, and their resource usage. Each environment record includes total run time, total RAM-GB Hours, max disk usage and the sponsored token that was used to create the environment, if applicable.

Note: This function only returns environments that were created after December 1st 2016

Request Path

GET /api/v3/envs/actions/getmultipleenvsresources?subscriptionId={subscriptionID}&starttime={starttime_value}&endtime={endtime_value}&skip={skip_value}&take={take_value}

Request Payload

None

Parameters

subscriptionId Optional (default is user’s subscription). Specifies a user subscription, where {subscriptionID} is the ID of the subscription. Provide the subscription if the user is a member of multiple subscriptions.

starttime Specifies the start of the time range, where {starttime_value} is the start of the time range in the format ISO 8601. For example, "2017-01-01"

endtime Specifies the end of the time range, where {endtime_value} is the end of the time range in the format ISO 8601. For example, “2017-02-01“.

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 environment 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

{
    "sponsoredLoginToken": "m0G3FECg4Cdda"
    "totalRuntimeHours": 54.2,
    "totalGbh": 78.45,
    "maxDiskGb": 10,
    "lastUpdateTime": "Mon, 09 Mar 2015 00:00:00 GMT",
    "name": "Web Test",
    "id": "EN5YTkVIYcD6kL9flyAAYyzg2"
}

Response Property Notes

sponsoredLoginToken A token used by the end user in order to create the environment. Null if the environment was not created by the sponsored link API. If more than one token was used to access the environment, the API returns one of the tokens used.
totalRuntimeHours The environment’s total run time in hours. If the environment was created recently and resource information is not yet available, the value is null.
totalGbh The environment’s total RAM per hour in gigabytes (GB). If the environment was created recently and resource information is not yet available, the value is null.
maxDiskGb The environment’s maximum disk usage in gigabytes (GB). If the environment was created recently and resource information is not yet available, the value is null.
lastUpdateTime The last time the environment was updated. If the environment was created recently and resource information is not yet available, the value is null.