Status

List

get

Retrieve a list of the Sites summary and state information.

Query parameters
NamestringOptional

Filter the result by server name (optional)

Responses
chevron-right
200

Success

application/json; api-version=1.0

Site 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.

priorityinteger · int32Optional

Priority of the Site

namestring · nullableOptional

Site Name

get
/api/Site/status

Get

get

Retrieve summary and state information about a Site

Path parameters
idinteger · int32Required

ID of the Site of which summary and state information will be retrieved.

Responses
chevron-right
200

Success

application/json; api-version=1.0

Site 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.

priorityinteger · int32Optional

Priority of the Site

namestring · nullableOptional

Site Name

get
/api/Site/{id}/status

Last updated