Status | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve a list of the summary and state information for all RAS Secure Gateways.

Query parameters

SiteIdinteger · int32optional

Site ID for which the summary and state information of all RAS Secure Gateway Servers will be retrieved (optional)

Serverstringoptional

Filter the result by server name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Gateway/status'

200

401

404

[
  {
    "id": "text",
    "siteId": 1,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "agentVer": "text",
    "server": "text",
    "serverOS": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "unhandledExceptions": 1,
    "machineId": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "cpuLoad": 1,
    "memLoad": 1,
    "diskRead": 1,
    "diskWrite": 1,
    "enabled": true,
    "mode": [
      "0 = Normal",
      "1 = Forwarding"
    ],
    "cipherStrength": [
      "0 = Low",
      "1 = Medium",
      "2 = High",
      "3 = Custom"
    ],
    "cipherStr": "text",
    "cipherPreference": true,
    "availableIPs": "text",
    "preferredBroker": "text",
    "clientConns": 1,
    "maxClientConns": 1,
    "clientSSLConns": 1,
    "maxClientSSLConns": 1,
    "httpRedirs": 1,
    "httpsRedirs": 1,
    "maxHTTPRedirs": 1,
    "maxHTTPSRedirs": 1,
    "wyseConns": 1,
    "maxWyseConns": 1,
    "wyseSSLConns": 1,
    "maxWyseSSLConns": 1,
    "webClientConns": 1,
    "webClientSSLConns": 1,
    "maxWebClientConns": 1,
    "maxWebClientSSLConns": 1,
    "deviceMgrTCPConns": 1,
    "deviceMgrTCPSSLConns": 1,
    "maxDeviceMgrTCPConns": 1,
    "maxDeviceMgrTCPSSLConns": 1,
    "activeRDPSessions": 1,
    "activeRDPSSLSessions": 1,
    "maxRDPSessions": 1,
    "maxRDPSSLSessions": 1,
    "rdpudpTunnels": 1,
    "rdpudpdtlsTunnels": 1,
    "maxRDPUDPTunnels": 1,
    "maxRDPUDPDTLSTunnels": 1,
    "totalConnections": 1,
    "cachedSockets": 1,
    "activeThreads": 1,
    "idleThreads": 1,
    "securityMode": [
      "0 = AllowAllExcept",
      "1 = AllowOnly"
    ],
    "gatewayTCPSock": "text",
    "rdptcpSock": "text",
    "sslVersion": [
      "2 = TLSv1",
      "3 = TLSv1_1",
      "4 = TLSv1_2",
      "5 = TLSv1_3"
    ],
    "gatewaySSLTCPSock": "text",
    "deviceManagerUDPSock": "text",
    "userPortalTCPSock": "text",
    "broadcastUDPSock": "text",
    "rdpTunnelUDPSock": "text",
    "rdpTunnelSSLUDPSock": "text",
    "serverMessage": "text",
    "fipsMode": "text"
  }
]

Success

Get

get

Retrieve summary and state information about a specified RAS Secure Gateway Server.

Path parameters

idinteger · int32required

ID of the RAS Secure Gateway server of which summary and state information will be retrieved