Get sizing recommendations for virtual environments

get

https://api.controlup.com/historical/v1/machines/sizing_recommendation/virtualization

Returns sizing recommendations to optimize resource allocation for machines based on historical information. Visit the Sizing Recommendations Report documentation for more details.

Required permission: Sizing Recommendations

❗️
The built-in Try It! console can return incorrect values. This endpoint returns IDs that are automatically rounded and displayed incorrectly in the response body due to a Javascript limitation.

Use the console to build requests and test connectivity only.

To get accurate data, copy the request and run it in another tool.

Query Params

activeSessionSizing

boolean

Defaults to false

Specifies which calculation method to use for sizing recommendations.

false: Calculates utilization averages across a continuous 24/7 period, regardless of whether a session is active. This includes nights and weekends when machines might be idle. If your machines have significantly different resource utilization depending on whether a session is active, then this method can under-estimate a machine's hardware requirements.

true: Only calculates utilization averages when an active user session is detected. This can provide a more realistic view of hardware requirements by excluding idle time.

_page

int32

≥ 1

The page number returned. The first page is 1.

_limit

int32

1 to 100000

The number of items returned per page. Minimum is 1.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully retrieved

400Bad Request - one of the inputs isn't correct

401User is not authorized to access the resource

403Authorization details are not provided

500Internal Server Error

501Internal Server Error

504Internal Server Error