Parallels RAS - REST API v1.0 API Reference
Overview
Parallels RAS comes with various APIs to help you develop custom applications that integrate with it. The RAS REST API is one of them. This guide describes how to use the REST API and documents the available REST resources, complete with request syntax and examples.
Getting Started
Applications communicate with Parallels RAS by sending HTTP or HTTPS requests. Parallels RAS answers with a JSON file in a response to every HTTP request.
All HTTP requests that you will use to retrieve and manage Parallels RAS resources have the following base structure:
https://<API-host>:20443/api/<URI>
where:
- <API-host> is the IP address or FQDN of the server on which the RAS REST API endpoint is installed.
- <URI> is a path to a REST resource that you would like to work with. The available resources and their paths and possible parameters are described in the OPERATIONS section. Request body schemas are documented in the SCHEMA DEFINITIONS section.
Logging in and Sending Requests
This section contains an example of RAS REST API usage that can help you quickly get started. The example demonstrates how to:
- Login to Parallels RAS and obtain an authentication token.
- Retrieve the information about all available RD Session Hosts.
- Retrieve the information about a specific RD Session Host.
- Modify RD Session Host properties.
Log in to Parallels RAS and obtain an authorization token
Before you can access any of the resources, you need to log in to Parallels RAS using administrator credentials and obtain an authorization token. This is accomplished by sending the following request:
POST https://<API-host>:20443/api/session/logon
Request headers The logon request must contain just the Content-Type request header. Subsequent requests must additionally contain the auth_token header, as you'll see in the examples that follow this one.
Content-Type: application/json; api-version=1.0
Request body The request body must contain the RAS administrator user name and password:
{
"username": "USER",
"password": "PASSWORD"
}
Response After sending the logon request, you will receive a reply containing the authentication token, which you will use in all subsequent requests:
{
"authToken": "[AUTHENTICATION_TOKEN]"
}
Throughout this document, AUTHENTICATION_TOKEN refers to the authentication token, which can be obtained from /api/session/logon.
Retrieve information about RD Session Hosts
Now that we have the authentication token, we can send requests to access various resources. In this example we'll first obtain the information about all available RD Session Hosts. In the example that follows, we'll obtain the information about a specific RD Session Host.
To retrieve the RD Session Host info, send the following request:
GET https://<API-host>:20443/api/RDS
Request headers This time the auth_token request header must also be included and must contain the authentication token that we've obtained earlier:
- Content-Type: application/json; api-version=1.0
- auth_token: [AUTHENTICATION_TOKEN]
Response The response will look similar to the following (with multiple RD Session Hosts in the farm, each block of the result set will contain the information about an individual server):
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
…
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "IP_ADDR",
"enabled": true,
"description": "",
"siteId": 1,
"id": 2
}
Retrieve information about a specific RD Session Host
To retrieve the information about a specific server, we'll use the same request as above but will add the server ID in the end:
GET https://<API-host>:20443/api/RDS/2/
The response will also be similar to the example above and will contain the information just for the specified server.
Modify RD Session Host properties
In this example we'll modify a property of the RD Session Host that we retrieved earlier. For simplicity let's modify the "description" field.
The request to modify properties of an RD Session Host has the following syntax:
PUT https://<API-host>:20443/api/RDS/2/
Note "2" at the end of the request, which specifies the ID of the RD Session Host that we want to modify.
Request headers
- Content-Type: application/json; api-version=1.0
- auth_token: [AUTHENTICATION_TOKEN]
Request body
{
"description": "description was updated!"
}
Response If the PUT request succeeds, you will get an empty response with code "204: No Content". To verify that the "description" field was in fact modified, let's use the same GET request that we used earlier: GET https://<API-host>:20443/api/RDS/2/
As we can see, the result now contains the updated "description" field:
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
…
"server": "IP_ADDR",
"enabled": true,
"description": "description was updated!",
"siteId": 1,
"id": 2
}
Examples
Below you can find some samples containing sequences of different types of HTTP requests:
Basic Sample How to start a session, get all sites, get a particular site, get all gateways, add a new GW, get a particular GW, create a RDS server, get the RDS server status, get the RDS server sessions.
RDS Sample How to get all RDS servers, add a new RDS Server, get the its status, get its sessions, add the Server to a RDS Group, update the RDS Group.
Publishing Sample How to manage published resources and use filtering options.
PA & Gateway Sample How to manage Publishing Agents and Gateways.
Licensing Sample How to manage license.
Version: 1.0
AdminAccount
List
Retrieves Admin Account/s.
Admin Account Name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
]
Create
Create a new Admin Account.
Admin Account settings
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Get CustomPermission
Retrieve the Custom Permissions of an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"sitePermissions": [
{
"siteId": "integer (int32)",
"rdsHosts": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"rdshGroups": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"remotePCs": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"gateways": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishingAgents": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"halb": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"themes": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"publishing": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"connection": {
"sitePermission": {
"permissions": "string"
},
"objectPermissions": [
{
"objId": "integer (int32)",
"permissions": "string"
}
]
},
"winDevices": {
"sitePermission": {}
}
}
]
}
Update CustomPermission
Update a Custom Permission of an Admin Account. Specifying a SiteId is mandatory except for Monitoring and Reporting. To set a Permission for a specific object, provide an ObjId within the body. To set a Global Permission, do not provide an ObjId within the body.
Custom Permission settings
Admin Account id
Site ID for the permission being set (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"objId": "integer (int32)",
"objectType": "string",
"permissions": "string"
}
Success
Unauthorized
Not Found
Get PowerPermission
Retrieve the Power Permissions of an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"adminId": "integer (int32)",
"allowSiteChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowPublishingChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
Update PowerPermission
Update a Power Permission of an Admin Account.
Power Permission settings
Admin Account id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"allowSiteChanges": "boolean",
"allowPublishingChanges": "boolean",
"allowConnectionChanges": "boolean",
"allowViewingReportingInfo": "boolean",
"allowViewingSiteInfo": "boolean",
"allowViewingPolicyInfo": "boolean",
"allowSessionManagement": "boolean",
"allowClientManagementChanges": "boolean",
"allowPolicyChanges": "boolean",
"allowAllSites": "boolean",
"allowInSiteIds": [
"integer (int32)"
]
}
Success
Unauthorized
Not Found
Get
Retrieve an Admin Account by id.
Admin Account Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"id": "integer (int32)",
"name": "string",
"type": "string",
"notify": "string",
"enabled": "boolean",
"email": "string",
"mobile": "string",
"groupName": "string",
"fullPermissions": "boolean",
"permissions": "string"
}
Update
Update Admin Account settings.
Admin Account settings
Admin Account id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"mobile": "string",
"enabled": "boolean",
"notify": "string",
"permissions": "string",
"fullPermissions": "boolean"
}
Success
Unauthorized
Not Found
Delete
Force Delete the Admin Account
Admin Account Id
Success
Unauthorized
Not Found
Certificates
List by Site ID
Retrieve a list of all the RAS Certificates.
Site ID of which the Certificates will be retrieved (optional)
Filter the result by certificate name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
]
Get
Retrieve a specific RAS Certificate.
ID of the Certificate to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Modify the properties of a RAS Certificate.
The Certificate to be updated
ID of the Certificate to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"newName": "string",
"description": "string",
"usage": "string",
"enabled": "boolean"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Certificate.
ID of the Certificate to be deleted
Success
Unauthorized
Not Found
Export
Export a RAS Certificate.
ID of the Certificate to be exported
Success
Unauthorized
Not Found
Import Public Key
This can be used to Import the Public Key of a Requested Certificate.
ID of the Certificate to be updated.
Public Key file to be uploaded.
Success
Unauthorized
Update Intermediate
This can be used to Update the Intermediate of an Imported Certificate.
ID of the Certificate to be updated.
Intermediate file to be uploaded.
Success
Unauthorized
Generate Request
Generate a new Certificate Request.
The Certificate Request details for a certificate to be requested.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Generate Self Signed
Generate a new Self Signed Certificate.
The Self Signed Certificate details for a certificate to be generated.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"name": "string",
"description": "string",
"usage": "string",
"enabled": "boolean",
"keySize": "string",
"countryCode": "string",
"expireInMonths": "integer (int32)",
"fullStateOrProvince": "string",
"city": "string",
"organisation": "string",
"organisationUnit": "string",
"email": "string",
"commonName": "string"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Import a Certificate
This can be used to import a new Certificate file.
The name of the target Certificate.
Site ID in which to add the Certificate.
A user-defined Certificate description.
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs.
Whether to enable or disable the certificate being created.
Certificate file to be uploaded.
Privatekey file to be uploaded.
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
Import a Pfx file
This can be used to import a Pfx file. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Certificate file, as well.
The name of the target Certificate.
Site ID in which to add the Certificate.
A user-defined Certificate description.
A set of usages to assign. To form a set of usages 'OR' individual usage enum IDs.
Whether to enable or disable the certificate being created.
Password of the pfx File to be uploaded.
Private Key File to be uploaded.
Success
Unauthorized
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"siteId": "integer (int32)",
"enabled": "boolean",
"status": "string",
"usage": "string",
"intermediate": "string",
"publicKey": "string",
"request": "string",
"expirationDate": "string (date-time)",
"keySize": "string",
"description": "string",
"commonName": "string",
"id": "integer (int32)"
}
ConnectionAllowedDevices
List
Retrieve a list of all the settings for RAS allowed devices
Site ID for which to retrieve all the settings for RAS allowed devices (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientMode": "string",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
]
Update
Update settings of a RAS allowed device
RAS allowed device settings
ID of the site for which the RAS Allowed device settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"allowClientMode": "string",
"allowClient2XOS": "boolean",
"allowClientBlackberry": "boolean",
"allowClientChromeApp": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientJava": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWinPhone": "boolean",
"allowClientWyse": "boolean",
"replicateSettings": "boolean",
"minBuild2XOS": "integer (int32)",
"minBuildBlackberry": "integer (int32)",
"minBuildChromeApp": "integer (int32)",
"minBuildAndroid": "integer (int32)",
"minBuildHTML5": "integer (int32)",
"minBuildIOS": "integer (int32)",
"minBuildJava": "integer (int32)",
"minBuildLinux": "integer (int32)",
"minBuildMAC": "integer (int32)",
"minBuildWebPortal": "integer (int32)",
"minBuildWindows": "integer (int32)",
"minBuildWinPhone": "integer (int32)",
"minBuildWyse": "integer (int32)"
}
Success
Unauthorized
Not Found
ConnectionAuthentication
List
Retrieve a list of all the settings for RAS authentication
Site ID for which to retrieve all the settings for RAS authentication (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
]
Update
Update RAS authentication settings
RAS allowed device settings
ID of the site for which the RAS authentication settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"authType": "string",
"allTrustedDomains": "boolean",
"domain": "string",
"useClientDomain": "boolean",
"forceNetBIOSCreds": "boolean",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
ConnectionMFA
List 2FA Settings
Retrieve a list of all the multi-factor authentication settings.
Site ID for which to retrieve multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"deepnetSettings": {
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
},
"safeNetSettings": {
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
},
"radiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"azureRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"duoRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"fortiRadiusSettings": {
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
},
"tekRadiusSettings": {}
}
Update 2FA Settings
Update multi-factor authentication settings.
Multi-factor authentication settings
ID of the site for which the multi-factor authentication settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"provider": "string",
"excludeClientIPs": "boolean",
"excludeClientMAC": "boolean",
"excludeClientGWIPs": "boolean",
"excludeUserGroup": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
List Azure Radius Settings
Retrieve a list of all the multi-factor authentication Azure Radius settings.
Site ID for which to retrieve multi-factor authentication Azure Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Azure Radius Settings
Update multi-factor authentication Azure Radius settings.
Multi-factor authentication Azure Radius settings
ID of the site for which the multi-factor authentication Azure Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Deepnet Settings
Retrieve a list of all the multi-factor authentication Deepnet settings.
Site ID for which to retrieve multi-factor authentication Deepnet settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"authMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"ssl": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string"
}
]
Update Deepnet Settings
Update multi-factor authentication Deepnet settings.
Multi-factor authentication Deepnet settings
ID of the site for which the multi-factor authentication Deepnet settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"activateEmail": "boolean",
"activateSMS": "boolean",
"app": "string",
"appID": "string",
"deepnetAuthMode": "string",
"deepnetAgent": "string",
"deepnetType": "string",
"defaultDomain": "string",
"enableSSL": "boolean",
"server": "string",
"port": "integer (int32)",
"tokenType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Duo Radius Settings
Retrieve a list of all the multi-factor authentication Duo Radius settings.
Site ID for which to retrieve multi-factor authentication Duo Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Duo Radius Settings
Update multi-factor authentication Duo Radius settings.
Multi-factor authentication Duo Radius settings
ID of the site for which the multi-factor authentication Duo Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Exclude GWs
Retrieve a list of excluded GW for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of GW for multi-factor authentication settings (optional)
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW to Exclude List
Add a GW to the exclude list for the multi-factor authentication settings.
GW IP to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude GW list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string"
}
Success
Unauthorized
Conflict
Delete GW from Exclude List
Remove a GW from the exclude list for the multi-factor authentication settings.
GW IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude GW address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string"
}
Success
Unauthorized
Not Found
List Exclude IPs
Retrieve a list of excluded IP for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of IP addresses for multi-factor authentication settings (optional)
Represents the type of IP. Valid values are: 0 for v4 and 1 for v6 (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP to Exclude List
Add an IP address to the exclude list for the multi-factor authentication settings.
IP to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude IP list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"ipType": "string"
}
Success
Unauthorized
Conflict
Delete IP from Exclude List
Remove an IP address from the exclude list for the multi-factor authentication settings.
IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude IP address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"ipType": "string"
}
Success
Unauthorized
Not Found
List Exclude MACs
Retrieve a list of excluded MAC for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of MAC addresses for multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC to Exclude List
Add a MAC address to the exclude list for the multi-factor authentication settings.
MAC address to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude MAC address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"macAddress": "string"
}
Success
Unauthorized
Conflict
Delete MAC from Exclude List
Remove a MAC address from the exclude list for the multi-factor authentication settings.
MAC address to be deleted from list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude MAC address list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"macAddress": "string"
}
Success
Unauthorized
Not Found
List Exclude Users/Groups
Retrieve a list of excluded Users/Groups for multi-factor authentication settings.
Site ID for which to retrieve the exclude list of Users/Groups for multi-factor authentication settings (optional)
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add User/Group to Exclude List
Add a User/Group to the exclude list for the multi-factor authentication settings.
User/Group to be added to the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude Users/Groups list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"type": "string"
}
Success
Unauthorized
Conflict
Delete User/Group from Exclude List
Remove a User/Group from the exclude list for the multi-factor authentication settings.
GW IP to be deleted from the list that is excluded from multi-factor authentication settings
Site ID for which to update the exclude Users/Groups list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"type": "string"
}
Success
Unauthorized
Not Found
List Forti Radius Settings
Retrieve a list of all the multi-factor authentication Forti Radius settings.
Site ID for which to retrieve multi-factor authentication Forti Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Forti Radius Settings
Update multi-factor authentication Forti Radius settings.
Multi-factor authentication Forti Radius settings
ID of the site for which the multi-factor authentication Forti Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Radius Settings
Retrieve a list of all the multi-factor authentication Radius settings.
Site ID for which to retrieve multi-factor authentication Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Radius Settings
Update multi-factor authentication Radius settings.
Multi-level authentication Radius settings
ID of the site for which the multi-factor authentication Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Radius Attributes
Retrieve a list of excluded Radius Attributes for multi-factor authentication settings.
Site ID for which to retrieve the list of Radius Attributes for multi-factor authentication settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
Add Radius Attribute
Add a Radius Attribute to the exclude list for the multi-factor authentication settings.
Radius Attribute to be added to the list that applies for multi-factor authentication settings
Site ID for which to update the Radius Attribute list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
Success
Unauthorized
Conflict
Delete Radius Attribute
Remove a Radius Attribute from the exclude list for the multi-factor authentication settings.
Radius Attribute to be removed from the list that applies for multi-factor authentication settings
Site ID for which to update the Radius Attribute list for multi-factor authentication settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"value": "string",
"name": "string",
"vendor": "string",
"attributeType": "string"
}
Success
Unauthorized
Not Found
List Safenet Settings
Retrieve a list of all the multi-factor authentication Safenet settings.
Site ID for which to retrieve multi-factor authentication Safenet settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"authMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string"
}
]
Update Safenet Settings
Update multi-factor authentication Safenet settings.
Multi-factor authentication Safenet settings
ID of the site for which the multi-factor authentication Safenet settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"safeNetAuthMode": "string",
"otpServiceURL": "string",
"userRepository": "string",
"tmsWebApiURL": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List Tek Radius Settings
Retrieve a list of all the multi-factor authentication Tek Radius settings.
Site ID for which to retrieve multi-factor authentication Tek Radius settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"attributeInfoList": [
{
"vendorID": "integer (int32)",
"attributeID": "integer (int32)",
"attributeType": "string",
"name": "string",
"vendor": "string",
"value": "string"
}
]
}
]
Update Tek Radius Settings
Update multi-factor authentication Tek Radius settings.
Multi-factor authentication Tek Radius settings
ID of the site for which the multi-factor authentication Tek Radius settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"server": "string",
"port": "integer (int32)",
"passwordEncoding": "string",
"retries": "integer (int32)",
"secretKey": "string",
"timeout": "integer (int32)",
"typeName": "string",
"usernameOnly": "boolean",
"forwardFirstPwdToAD": "boolean",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
List TOTP Settings
Retrieve a list of all the multi-factor authentication TOTP settings.
Site ID for which to retrieve multi-factor authentication TOTP settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"type": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
]
Update TOTP Settings
Update multi-factor authentication TOTP settings.
Multi-factor authentication TOTP settings
ID of the site for which the multi-factor authentication TOTP settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"excludeUserGroup": "boolean",
"totpType": "string",
"userEnrollment": "string",
"untilDateTime": "string (date-time)"
}
Success
Unauthorized
Not Found
ConnectionSettings
List
Retrieve a list of all the settings for RAS sessions
Site ID for which to retrieve all the settings for RAS sessions (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"fipsMode": "string",
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"replicateSettings": "boolean",
"siteId": "integer (int32)"
}
]
Update
Update settings of a RAS session
RAS session settings
ID of the site for which the RAS session settings will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"remoteIdleSessionTimeout": "integer (int32)",
"logoffIdleSessionTimeout": "integer (int32)",
"cachedSessionTimeout": "integer (int32)",
"fipsMode": "string",
"replicateSettings": "boolean"
}
Success
Unauthorized
Not Found
GW
List by Site ID
Retrieve a list of all the RAS Secure Client Gateway Servers.
Site ID of which the Gateway Servers will be retrieved (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Create
Create a new RAS Secure Client Gateway Server.
The Gateway server to be created
If this parameter is included, the Gateway software will NOT be installed on the target server. The parameter should only be included if the server already has the software installed. If you need to install the software, omit this parameter. When installing the Gateway software, your RAS admin credentials will be used to push install the software. These are the credentials you used to connect to the RAS farm. If needed, you can specify different credentials using the Username and Password parameters.
An administrator account to push install the Gateway software on the target server. If this parameter is omitted, your RAS admin username (and password) will be used
The password of the account specified in the Username parameter.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Get
Retrieve a specified RAS Secure Client Gateway Server.
ID of the Gateway server to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Modify the properties of a RAS Secure Client Gateway Server.
The Gateway server to be updated
ID of the Gateway server to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"newServer": "string",
"description": "string",
"ipVersion": "string",
"iPs": "string",
"bindV4Addresses": "string",
"optimizeConnectionIPv4": "string",
"bindV6Addresses": "string",
"optimizeConnectionIPv6": "string",
"inheritDefaultModeSettings": "boolean",
"inheritDefaultNetworkSettings": "boolean",
"inheritDefaultSslTlsSettings": "boolean",
"inheritDefaultHTML5Settings": "boolean",
"inheritDefaultWyseSettings": "boolean",
"inheritDefaultSecuritySettings": "boolean",
"inheritDefaultWebSettings": "boolean",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Secure Client Gateway Server.
The Gateway server to be deleted
When this parameter is included, the Gateway software will NOT be removed from the server. If you want to remove the software, omit this parameter. When removing the software, your RAS admin credentials will be used to remotely execute the uninstaller on the target server. You can specify different credentials if needed using the Username and Password parameters.
An administrator account name to remotely uninstall the Gateway software from the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
ID of the Gateway server to be deleted
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Not Found
Upload a Certificate file
This can be used to upload a Certificate file for a specified GW server. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Private Key file, as well.
ID of the Gateway server to be updated.
Certificate file to be uploaded.
Privatekey file to be uploaded.
Success
Unauthorized
Upload a Private Key file
This can be used to upload a Private Key file for a specified GW server. If the pfx password is used (optional), the file has to be in a pfx format and will be used as a Certificate file, as well.
Password of the pfx File to be uploaded.
ID of the Gateway server to be updated.
Private Key File to be uploaded.
Success
Unauthorized
Get Status
Retrieve summary and state information about a specified RAS Secure Client Gateway Server.
ID of the Gateway server of which summary and state information will be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"gwMode": "string",
"cipherStrength": "string",
"cipherStr": "string",
"availableIPs": "string",
"preferredPA": "string",
"clientConns": "integer (int32)",
"maxClientConns": "integer (int32)",
"clientSSLConns": "integer (int32)",
"maxClientSSLConns": "integer (int32)",
"httpRedirs": "integer (int32)",
"httpsRedirs": "integer (int32)",
"maxHTTPRedirs": "integer (int32)",
"maxHTTPSRedirs": "integer (int32)",
"wyseConns": "integer (int32)",
"maxWyseConns": "integer (int32)",
"wyseSSLConns": "integer (int32)",
"maxWyseSSLConns": "integer (int32)",
"htmL5Conns": "integer (int32)",
"htmL5SSLConns": "integer (int32)",
"maxHTML5Conns": "integer (int32)",
"maxHTML5SSLConns": "integer (int32)",
"clientMgrTCPConns": "integer (int32)",
"clientMgrTCPSSLConns": "integer (int32)",
"maxClientMgrTCPConns": "integer (int32)",
"maxClientMgrTCPSSLConns": "integer (int32)",
"activeRDPSessions": "integer (int32)",
"activeRDPSSLSessions": "integer (int32)",
"maxRDPSessions": "integer (int32)",
"maxRDPSSLSessions": "integer (int32)",
"rdpudpTunnels": "integer (int32)",
"rdpudpdtlsTunnels": "integer (int32)",
"maxRDPUDPTunnels": "integer (int32)",
"maxRDPUDPDTLSTunnels": "integer (int32)",
"totalConnections": "integer (int32)",
"cachedSockets": "integer (int32)",
"activeThreads": "integer (int32)",
"idleThreads": "integer (int32)",
"securityMode": "string",
"gatewayTCPSock": "string",
"rdptcpSock": "string",
"sslVersion": "string",
"gatewaySSLTCPSock": "string",
"clientManagerUDPSock": "string",
"htmL5TCPSock": "string",
"broadcastUDPSock": "string",
"rdpTunnelUDPSock": "string",
"rdpTunnelSSLUDPSock": "string",
"serverMessage": "string",
"fipsMode": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
List Status
Retrieve a list of the summary and state information for all RAS Secure Client Gateways.
Site ID for which the summary and state information of all Gateway Servers will be retrieved (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"gwMode": "string",
"cipherStrength": "string",
"cipherStr": "string",
"availableIPs": "string",
"preferredPA": "string",
"clientConns": "integer (int32)",
"maxClientConns": "integer (int32)",
"clientSSLConns": "integer (int32)",
"maxClientSSLConns": "integer (int32)",
"httpRedirs": "integer (int32)",
"httpsRedirs": "integer (int32)",
"maxHTTPRedirs": "integer (int32)",
"maxHTTPSRedirs": "integer (int32)",
"wyseConns": "integer (int32)",
"maxWyseConns": "integer (int32)",
"wyseSSLConns": "integer (int32)",
"maxWyseSSLConns": "integer (int32)",
"htmL5Conns": "integer (int32)",
"htmL5SSLConns": "integer (int32)",
"maxHTML5Conns": "integer (int32)",
"maxHTML5SSLConns": "integer (int32)",
"clientMgrTCPConns": "integer (int32)",
"clientMgrTCPSSLConns": "integer (int32)",
"maxClientMgrTCPConns": "integer (int32)",
"maxClientMgrTCPSSLConns": "integer (int32)",
"activeRDPSessions": "integer (int32)",
"activeRDPSSLSessions": "integer (int32)",
"maxRDPSessions": "integer (int32)",
"maxRDPSSLSessions": "integer (int32)",
"rdpudpTunnels": "integer (int32)",
"rdpudpdtlsTunnels": "integer (int32)",
"maxRDPUDPTunnels": "integer (int32)",
"maxRDPUDPDTLSTunnels": "integer (int32)",
"totalConnections": "integer (int32)",
"cachedSockets": "integer (int32)",
"activeThreads": "integer (int32)",
"idleThreads": "integer (int32)",
"securityMode": "string",
"gatewayTCPSock": "string",
"rdptcpSock": "string",
"sslVersion": "string",
"gatewaySSLTCPSock": "string",
"clientManagerUDPSock": "string",
"htmL5TCPSock": "string",
"broadcastUDPSock": "string",
"rdpTunnelUDPSock": "string",
"rdpTunnelSSLUDPSock": "string",
"serverMessage": "string",
"fipsMode": "string",
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
GWDefaultSettings
Get
Retrieve the Gateway Default settings.
Site ID for which to retrieve GW Default settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"siteId": "integer (int32)",
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Update
Update the Gateway default settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
GW settings
Site ID for which to update the GW Default settings (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"gwMode": "string",
"normalModeForwarding": "boolean",
"forwardGatewayServers": "string",
"autoPreferredPA": "boolean",
"preferredPAId": "integer (int32)",
"forwardHttpServers": "string",
"enableGWPort": "boolean",
"gwPort": "integer (int32)",
"enableRDP": "boolean",
"rdpPort": "integer (int32)",
"broadcast": "boolean",
"enableRDPUDP": "boolean",
"enableClientManagerPort": "boolean",
"dosPro": "boolean",
"enableSSL": "boolean",
"sslPort": "integer (int32)",
"minSSLVersion": "string",
"cipherStrength": "string",
"cipher": "string",
"autoCertificate": "boolean",
"certificateId": "integer (int32)",
"enableHSTS": "boolean",
"hstsMaxAge": "integer (int32)",
"hstsIncludeSubdomains": "boolean",
"hstsPreload": "boolean",
"enableHTML5": "boolean",
"htmL5Port": "integer (int32)",
"launchMethod": "string",
"allowLaunchMethod": "boolean",
"allowAppsInNewTab": "boolean",
"usePreWin2000LoginFormat": "boolean",
"allowEmbed": "boolean",
"allowFileTransfer": "boolean",
"allowClipboard": "boolean",
"enableAlternateNLBHost": "boolean",
"alternateNLBHost": "string",
"enableAlternateNLBPort": "boolean",
"alternateNLBPort": "integer (int32)",
"enableWyseSupport": "boolean",
"securityMode": "string",
"macAllowExcept": [
"string"
],
"macAllowOnly": [
"string"
],
"webRequestsURL": "string",
"webCookie": "string"
}
Success
Unauthorized
Not Found
License
Retrieve
Retrieve the current license setting.
Success
Activate
Activates Parallels RAS using a valid license key. Also allows to activate Parallels RAS as a trial version. Trial version will be activated if the key is empty.
License settings.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"password": "string",
"key": "string"
}
Success
Unauthorized
Deactivate
Deactivates the current license key used by Parallels RAS.
License settings
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"email": "string",
"password": "string"
}
Success
Unauthorized
PA
List
Retrieve information about a list of RAS Publishing Agent servers.
Site ID for which to retrieve the RAS Publishing Agent server information (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
]
Create
Add a new RAS Publishing Agent server to a site. The agent software will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
RAS Publishing Agent server
Specifies NOT to install the agent software on the server. If you omit this parameter, the agent will be push installed on the server using your RAS admin credentials To specify different credentials, include the Username and Password parameters.
An administrator account for push installing the agent on the server. If this parameter is omitted, your RAS admin username and password will be used.
The password of the account specified in the Username parameter.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"server": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Get
Retrieve a specific Publishing Agent by id.
RAS Publishing Agent server Id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"priority": "integer (int32)",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean",
"markedForDeletion": "boolean",
"server": "string",
"enabled": "boolean",
"description": "string",
"siteId": "integer (int32)",
"id": "integer (int32)"
}
Update
Update settings of a RAS Publishing Agent server. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"description": "string",
"ip": "string",
"alternativeIPs": "string",
"standby": "boolean"
}
Success
Unauthorized
Not Found
Delete
Delete a RAS Publishing Agent server from a site. The RAS Publishing Agent server will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
RAS Publishing Agent server
Include this parameter if you wish to keep the RAS Publishing Agent software on the server. To uninstall the agent software, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials by including the Username and Password parameters.
A username that will be used to remotely uninstall the RAS Publishing Agent software from the target server. If this parameter is omitted, your RAS admin username and password will be used by default.
The password of the account specified in the Username parameter.
RAS Publishing Agent server Id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{}
Success
Unauthorized
Not Found
Update Priority
Increase or decrease the priority for a specified RAS Publishing Agent server.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"direction": "string"
}
Success
Unauthorized
Not Found
Promote
Promote a RAS Publishing Agent server to master.The license key used must be registered in Parallels My Account. To activate Parallels RAS as a trial, omit the key parameter.
RAS Publishing Agent server
RAS Publishing Agent server id
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"paUsername": "string",
"paPassword": "string"
}
Success
Unauthorized
Not Found
Get Status
Retrieve status information for a specified RAS Publishing Agent server.
RAS Publishing Agent server id
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
List Status
Retrieve a list of RAS Publishing Agent servers with status information.
Site ID for which to retrieve the RAS Publishing Agent server information (optional)
Filter the result by server name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"cpuLoad": "integer (int32)",
"memLoad": "integer (int32)",
"diskRead": "integer (int32)",
"diskWrite": "integer (int32)",
"enabled": "boolean",
"id": "string",
"server": "string",
"siteId": "integer (int32)",
"agentVer": "string",
"serverOS": "string",
"serviceStartTime": "string",
"systemBootTime": "string",
"unhandledExceptions": "integer (int32)",
"agentState": "string",
"serverType": "string",
"logLevel": "string"
}
]
PrintingSettings
Get
Retrieve information about RAS printing settings.
Site ID for which to retrieve the RAS universal printing settings (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string",
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"autoInstallFonts": [
"string"
],
"printerNamePattern": "string"
}
Update
Update printing settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RAS Printing settings
Site id (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"printerDriversArray": [
"string"
],
"excludedFontsArray": [
"string"
],
"printerNamePattern": "string",
"embedFonts": "boolean",
"replicatePrinterFont": "boolean",
"replicatePrinterPattern": "boolean",
"replicatePrinterDrivers": "boolean",
"driverAllowMode": "string",
"printerRetention": "string"
}
Success
Unauthorized
Not Found
Get Auto Install Fonts
Retrieve information about RAS printing settings font of a site.
Site ID for which to retrieve the RAS printing settings font (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Auto Install Font
Add a new RAS Printing settings font to a site.
Id of the site to which the font will be added (optional)
Font file to be uploaded.
Success
Unauthorized
Conflict
Delete Auto Install Fonts
Delete a RAS Printing settings font from a site.
RAS Printing settings font
Id of the site from which the font will be deleted (optional)
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"fontName": "string"
}
Success
Unauthorized
Not Found
PubDefaultSettings
Get
Retrieve default settings used to configure published resources for a specific Site
Site ID from which to retrieve the defaults
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"siteId": "integer (int32)",
"startPath": "string",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"replicateShortcutSettings": "boolean",
"replicateDisplaySettings": "boolean",
"waitForPrinters": "boolean",
"startMaximized": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"replicateLicenseSettings": "boolean"
}
Update
Modify default settings used to configure published resources for a specific Site
Publishing defualts configuration
Site ID from which to update the defaults
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"createShortcutOnDesktop": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"colorDepth": "string"
}
Success
Unauthorized
Not Found
PubFolders
List
Retrieve a list of all the published folders
Site ID for which to retrieve all the published RDS folders (optional)
Filter the result by name (optional)
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
]
Create
Add a published folder to a site.
Published folder configuration
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"adminOnly": "boolean",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve information about a specified published folder.
ID of the published folder to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"adminOnly": "boolean",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Update
Modify properties of a published folder.
Published folder configuration
ID of the published folder to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"adminOnly": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete
Delete a published folder
ID of the published folder to be deleted
Success
Unauthorized
Not Found
Get Client filter
Retrieves the filtered client device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Client filter
Add a client device name to the filter of type 'Client Device Name' for the specified published resource.
Published item client filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"client": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete Client filter
Delete a client device name to the filter of type 'Client Device Name' for the specified published resource.
ID of the published resource to be updated
Name of the Client filter to be deleted
Success
Unauthorized
Not Found
Get GW filter
Retrieves the filtered Gateways for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW filter
Add a RAS Secure Client Gateway to the filter of type 'Gateway' for the specified published resource.
Published item GW filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete GW filter
Delete a RAS Secure Client Gateway from the filter of type 'Gateway' for the specified published resource.
ID of the published resource to be updated
IP of the Gateway filter to be deleted
Success
Unauthorized
Not Found
Get IP filter
Retrieves the IP address list for the specified published resource.
ID of the published resource to be updated
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
]
}
Add IP filter
Add an IP address to the filter of type 'IP Address' for the specified published resource.
Published item IP filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete IP filter
Delete an IP address from the filter of type 'IP Address' for the specified published resource.
ID of the published resource to be updated
IP to be deleted from the IP filter
Success
Unauthorized
Not Found
Get MAC filter
Retrieves the filtered MAC addresses for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add MAC filter
Add a MAC address to the filter of type 'MAC Address' for the specified published resource.
Published item MAC filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"mac": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete MAC filter
Delete a MAC address from the filter of type 'MAC Address' for the specified published resource.
ID of the published resource to be updated
MAC address to be deleted from the filter
Success
Unauthorized
Not Found
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Sort
SortFolder: sort PubFolders by folder name in the Published Resources tree.
ID of Pub item to invoke.
Success
Unauthorized
Get User filter
Retrieves the filtered user accounts device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
{
"account": "string",
"type": "string",
"sid": "string"
}
]
Add User filter
Add a User account to the filter of type 'User' for the specified published resource.
Published item user filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"account": "string",
"sid": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete User filter
Delete a User account from the filter of type 'User' for the specified published resource.
ID of the published resource to be updated
Account of User to be deleted from the filter
Success
Unauthorized
Not Found
PubItemOSFilter
Update Client OS filter
Add an OS filter for the specified published resource.
Published item client OS filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
PubItems
List
Retrieve a list of all the published resources
Site ID for which to retrieve published resources (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve a specified published resource
ID of the published resource to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Delete
Delete a published resource
ID of the published resource to be deleted
Success
Unauthorized
Not Found
Copy
Copy (duplicate) a published item.
The Published item to be copied.
ID of Pub item to duplicate.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Download Icon
Save the published resource icon to a specified directory. The command returns the full path (with filename) of the saved published resource icon.
ID of the published resource of which the icon will be retrieved
Success
Unauthorized
Not Found
Update resource icon
Publish a resource icon file name. Can be an executable (.exe), a .dll or a .ico file.
Index of the icon to be loaded from the binary specified in the Icon property(optional)
ID of the published resource for which the icon will be updated
File that will be used as the new icon
Success
Unauthorized
Not Found
Move
Move a published item to a specified node in the Published Resources tree.
The Published item to be moved.
ID of Pub item to move.
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"parentId": "integer (int32)",
"previousId": "integer (int32)"
}
Success
Unauthorized
Not Found
PubRDSApps
List
Retrieve a list of all the published RDS applications
Site ID for which to retrieve all the published RDS applications (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Create
Add a published RDS application to a site.
undefined
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"target": "string",
"parameters": "string",
"startIn": "string",
"startOnLogon": "boolean",
"winType": "string",
"name": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"siteId": "integer (int32)",
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean"
}
Success
Unauthorized
Conflict
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (201 Created)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Get
Retrieve a specified published RDS application
ID of the published RDS application to be retrieved
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
{
"publishFromServer": [
"integer (int32)"
],
"publishFromGroup": [
"integer (int32)"
],
"perServerAttributes": [
{
"parameters": "string",
"startIn": "string",
"target": "string",
"serverId": "integer (int32)"
}
],
"publishFrom": "string",
"enableFileExtensions": "boolean",
"inheritDisplayDefaultSettings": "boolean",
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritLicenseDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"fileExtensions": [
{
"extension": "string",
"parameters": "string",
"enabled": "boolean"
}
],
"winType": "string",
"parameters": "string",
"startIn": "string",
"target": "string",
"startOnLogon": "boolean",
"inheritShortcutDefaultSettings": "boolean",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"name": "string",
"type": "string",
"parentId": "integer (int32)",
"previousId": "integer (int32)",
"description": "string",
"enabled": "boolean",
"publishToSite": [
"integer (int32)"
],
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"allowedUsers": [
{
"account": "string",
"type": "string",
"sid": "string"
}
],
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"allowedClients": [
"string"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"allowedIP4s": [
{
"from": "string",
"to": "string"
}
],
"allowedIP6s": [
{
"from": "string",
"to": "string"
}
],
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"allowedMACs": [
"string"
],
"gwFilterEnabled": "boolean",
"allowedGWs": [
"string"
],
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowedOSes": {
"chrome": "boolean",
"android": "boolean",
"htmL5": "boolean",
"iOS": "boolean",
"linux": "boolean",
"mac": "boolean",
"webPortal": "boolean",
"windows": "boolean",
"wyse": "boolean"
},
"id": "integer (int32)"
}
Update
Modify properties of a published RDS application.
Published RDS application configuration
ID of the published RDS application to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"publishFrom": "string",
"publishFromGroupIds": [
"integer (int32)"
],
"publishFromServerIds": [
"integer (int32)"
],
"replicateDisplaySettings": "boolean",
"startMaximized": "boolean",
"waitForPrinters": "boolean",
"waitForPrintersTimeout": "integer (int32)",
"colorDepth": "string",
"inheritDisplayDefaultSettings": "boolean",
"replicateLicenseSettings": "boolean",
"disableSessionSharing": "boolean",
"oneInstancePerUser": "boolean",
"conCurrentLicenses": "integer (int32)",
"licenseLimitNotify": "string",
"inheritLicenseDefaultSettings": "boolean",
"enableFileExtensions": "boolean",
"replicateFileExtensionSettings": "boolean",
"replicateDefaultServerSettings": "boolean",
"fileExtensions": "string",
"serverId": "integer (int32)",
"target": "string",
"parameters": "string",
"startIn": "string",
"winType": "string",
"replicateShortcutSettings": "boolean",
"createShortcutOnDesktop": "boolean",
"createShortcutInStartFolder": "boolean",
"createShortcutInStartUpFolder": "boolean",
"startPath": "string",
"inheritShortcutDefaultSettings": "boolean",
"startOnLogon": "boolean",
"newName": "string",
"enabled": "boolean",
"description": "string",
"publishToSiteIds": [
"integer (int32)"
],
"ipFilterEnabled": "boolean",
"ipFilterReplicate": "boolean",
"clientFilterEnabled": "boolean",
"clientFilterReplicate": "boolean",
"macFilterEnabled": "boolean",
"macFilterReplicate": "boolean",
"userFilterEnabled": "boolean",
"userFilterReplicate": "boolean",
"gwFilterEnabled": "boolean",
"osFilterEnabled": "boolean",
"osFilterReplicate": "boolean",
"allowClientChrome": "boolean",
"allowClientAndroid": "boolean",
"allowClientHTML5": "boolean",
"allowClientIOS": "boolean",
"allowClientLinux": "boolean",
"allowClientMAC": "boolean",
"allowClientWebPortal": "boolean",
"allowClientWindows": "boolean",
"allowClientWyse": "boolean",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete
Delete a published application from a site.
ID of the published RDS application to be deleted
Success
Unauthorized
Not Found
Get Client filter
Retrieves the filtered client device names for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add Client filter
Add a client device name to the filter of type 'Client Device Name' for the specified published resource.
Published item client filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"client": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete Client filter
Delete a client device name to the filter of type 'Client Device Name' for the specified published resource.
ID of the published resource to be updated
Name of the Client filter to be deleted
Success
Unauthorized
Not Found
Create File Extension
Add a file extension for the specified published RDS application.
File extension for published RDS application to be added
ID of the published RDS application to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"extension": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Update File Extension
Modify properties of a file extension for the specified published RDS application.
File extension for published RDS application to be updated
ID of the published RDS application to be updated
Name of the file extension that will be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"enabled": "boolean",
"parameters": "string",
"extension": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Delete File Extension
Remove a file extension from the specified published RDS application.
ID of the published RDS application to be updated
The file extension that will be deleted
Success
Unauthorized
Not Found
Get GW filter
Retrieves the filtered Gateways for the specified published resource.
ID of the published resource to be acquired.
Success
Unauthorized
Not Found
Response Content-Types: text/plain; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0
Response Example (200 OK)
[
"string"
]
Add GW filter
Add a RAS Secure Client Gateway to the filter of type 'Gateway' for the specified published resource.
Published item GW filter configuration
ID of the published resource to be updated
Request Content-Types: application/json-patch+json; api-version=1.0, application/json; api-version=1.0, text/json; api-version=1.0, application/*+json; api-version=1.0
Request Example
{
"ip": "string",
"siteId": "integer (int32)"
}
Success
Unauthorized
Not Found
Conflict
Delete GW filter
Delete a RAS Secure Client Gateway from the filter of type 'Gateway' for the specified published resource.
ID of the published resource to be updated