Provider | Parallels REST API

Get Provider

get

Retrieves the agent diagnostic information about an installed RAS Provider Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve Provider Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Provider Agent information (optional).

Responses

application/json; api-version=1.0

objectOptional

Provider Agent Diagnostic

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/Provider HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = CheckCredentials",
    "7 = InvalidCredentials",
    "8 = CannotConnectToVDIAgent",
    "11 = UnsupportedVDI",
    "12 = VDITypeCheck",
    "16 = FreeESXLicenseNotSupported",
    "17 = ManagedESXNotSupported",
    "20 = StartCheckUDP",
    "22 = InvalidProviderVersion",
    "25 = SettingsNotApplied",
    "26 = InvalidVDIType",
    "27 = UnsupportedOS"
  ],
  "connectedBrokerIP": "text",
  "providerPort": 1,
  "version": 1
}