Status

List Host Statuses by Site ID

get

Retrieve the list of all statuses.

Query parameters
SiteIdinteger · int32Optional

Site ID of which the sessions will be retrieved (optional)

ServerstringOptional

Filter the result by server name (optional)

Responses
chevron-right
200

Success

application/json; api-version=1.0

Provider Host

namestring · nullableOptional

Provider name.

serverstring · nullableOptional

FQDN or IP address of the RAS Server.

statestring · enumOptional

VDI Host State

Possible values:
connectionstring · enumOptional

VDI Host Connection

Possible values:
templateNamestring · nullableOptional

Template Name.

templateIDinteger · int32Optional

Template ID.

templateTypestring · enumOptional

Host Session Type

Possible values:
userstring · nullableOptional

Provider user name.

ipstring · nullableOptional

IP of the Provider.

hostIDstring · nullableOptional

Host ID.

providerIDinteger · int32Optional

Provider ID.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

logLevelstring · enumOptional

RAS Log Level

Possible values:
isMaintenancebooleanOptional

Whether the Provider is in maintenance or not.

isTemplatebooleanOptional

Whether the Provider is a template or not.

agentStatestring · enumOptional

Agent State

Possible values:
get
/api/Provider/VM/Host/Status

List Host Statuses by Provider ID

get

Retrieve a list of statuses for a specific Provider.

Path parameters
providerIdinteger · int32Required

The ID of the Provider server.

Responses
chevron-right
200

Success

application/json; api-version=1.0

Provider Host

namestring · nullableOptional

Provider name.

serverstring · nullableOptional

FQDN or IP address of the RAS Server.

statestring · enumOptional

VDI Host State

Possible values:
connectionstring · enumOptional

VDI Host Connection

Possible values:
templateNamestring · nullableOptional

Template Name.

templateIDinteger · int32Optional

Template ID.

templateTypestring · enumOptional

Host Session Type

Possible values:
userstring · nullableOptional

Provider user name.

ipstring · nullableOptional

IP of the Provider.

hostIDstring · nullableOptional

Host ID.

providerIDinteger · int32Optional

Provider ID.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

logLevelstring · enumOptional

RAS Log Level

Possible values:
isMaintenancebooleanOptional

Whether the Provider is in maintenance or not.

isTemplatebooleanOptional

Whether the Provider is a template or not.

agentStatestring · enumOptional

Agent State

Possible values:
get
/api/Provider/{providerId}/VM/Host/Status

Get Host Status

get

Retrieve a specific Host Status.

Path parameters
providerIdinteger · int32Required

The ID of the Provider server.

vmIdstringRequired

VM ID.

Responses
chevron-right
200

Success

application/json; api-version=1.0

Provider Host

namestring · nullableOptional

Provider name.

serverstring · nullableOptional

FQDN or IP address of the RAS Server.

statestring · enumOptional

VDI Host State

Possible values:
connectionstring · enumOptional

VDI Host Connection

Possible values:
templateNamestring · nullableOptional

Template Name.

templateIDinteger · int32Optional

Template ID.

templateTypestring · enumOptional

Host Session Type

Possible values:
userstring · nullableOptional

Provider user name.

ipstring · nullableOptional

IP of the Provider.

hostIDstring · nullableOptional

Host ID.

providerIDinteger · int32Optional

Provider ID.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

logLevelstring · enumOptional

RAS Log Level

Possible values:
isMaintenancebooleanOptional

Whether the Provider is in maintenance or not.

isTemplatebooleanOptional

Whether the Provider is a template or not.

agentStatestring · enumOptional

Agent State

Possible values:
get
/api/Provider/{providerId}/VM/{vmId}/Host/Status