Status

List

get

Retrieve a list of Provider servers with status information.

Query parameters
SiteIdinteger · int32Optional

Site ID for which Provider servers with status information will be retrieved (optional)

ServerstringOptional

Filter the result by server name (optional)

Responses
chevron-right
200

Success

application/json; api-version=1.0

Provider System Information

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

preferredBrokerstring · nullableOptional

Specifies the preferred Connection Broker.

highAvailabilityStatestring · enumOptional

High Availability State

Possible values:
activeConnectionsinteger · int32Optional

Number of active connections.

vdiAgentstring · nullableOptional

FQDN or IP address of the VDI Agent.

friendlyNamestring · nullableOptional

The Provider Friendly Name.

get
/api/Provider/Status

Get

get

Retrieve the Provider status information for the server.

Path parameters
idinteger · int32Required

Provider ID

Responses
chevron-right
200

Success

application/json; api-version=1.0

Provider System Information

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

preferredBrokerstring · nullableOptional

Specifies the preferred Connection Broker.

highAvailabilityStatestring · enumOptional

High Availability State

Possible values:
activeConnectionsinteger · int32Optional

Number of active connections.

vdiAgentstring · nullableOptional

FQDN or IP address of the VDI Agent.

friendlyNamestring · nullableOptional

The Provider Friendly Name.

get
/api/Provider/{id}/Status