API Reference

List machines

get
https://api.controlup.com/vdi/config/v1/machines

Retrieves a paginated list of machines with optional filtering, sorting, and search capabilities

Query Params
integer
≥ 1
Defaults to 1

Page number for pagination (1-based)

integer
1 to 500
Defaults to 50

Number of items per page

string

Field name to sort by. Valid fields: objectGuid, name, fqdn, netBiosName, siteId. Defaults to 'name' if invalid field provided.

string
enum
Defaults to Asc

Sort order direction

Allowed:
string

A case-insensitive search filter on the fqdn and description fields. If you enter multiple terms, such as production server, the endpoint returns all machines that contain 'production' in either of the searched fields AND 'server' in either of the searched fields. You can use double quotes to search for exact phrases (for example, "production server").

string

Filter machines by exact folder path match

string

Filter machines by monitor site name

boolean

If set to true, the endpoint only returns machines that are capable of establishing outbound connections from the machine to ControlUp's services.

boolean
Defaults to false

Include deleted machines in the results

boolean
Defaults to false

If set to true, the endpoint returns the following additional details:

  • Agent: Port number and install mode
  • LoadBalancing: Weight and preferred weight settings
  • Management: Information about which extension added the machine via sync
  • VdiStatus: Last outbound connection date and when the machine was missed in EUC
string

Comma-separated list of fields to include in the response. When specified, only these fields will be returned for each machine.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?