Skip to navigation
API Referenceload-balancer-rules

List virtual machines for a load balancer rule

Returns assigned VMs by default. Set applied=false to list VMs available for assignment.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

ruleIdstringRequired
ID of the load balancer rule

Query parameters

pageintegerOptional>=1

Page number, 1-indexed. Defaults to 1 when omitted.

pageSizeintegerOptional1-500

Items per page. Defaults to 100 when omitted; server cap 500.

appliedbooleanOptional

If true (default), returns assigned VMs. If false, returns VMs available for assignment.

Response

totaldouble

Total number of items matching the request, across all pages. Use this together with pageSize to compute how many pages exist.

datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error