Version

Retrieve the version of the Remote Application Server Web Service.

GET/api/WebService/version

Response

Success

Request

Import Certificate

This can be used to Import and change the PFX Certificate within Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

PUT/api/WebService/settings/ImportCertificate

Body

CertificateFilestring (binary)

Upload File

Response

No Content

Request

Response

Settings

Get

Retrieve the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

GET/api/WebService/settings

Response

Success

Body

allowedHostsnullable string

Specifies the Allowed Hosts

kestrelKestrelConfig (object)

The Kestrel configuration

endPointsEndPointsConfig (object)

The endpoints configuration

httpsDefaultCertHttpsDefaultCertConfig (object)

The HTTPS default certificate configuration

urlnullable string

URL of the configuration

certificateCertificateConfig (object)

The Certificate Policy

pathnullable string

Path where the certificate lies.

encryptedPasswordnullable string

Encrypted Password of the certificate.

webAdminServiceWebAdminServiceConfig (object)

RAS Web Administration Service configuration

webConsoleWebConsoleConfig (object)

Web Console configuration

enableboolean

Whether the configuration is enabled or not.

basePathnullable string

Specifies the Web Console Base Path.

pollingIntervalinteger (int32)

Specifies the Web Console Polling Interval.

logLevelinteger (int32)

Specifies the Web Console Log Level.

restRESTConfig (object)

The REST configuration

enableboolean

Whether the REST configuration is enabled or not.

rasServerRASServerConfig (object)

The RAS server configuration

licenseServernullable string

RAS Licensing server

secondaryServersnullable array of string

List of secondary servers

itemsstring

sessionSessionConfig (object)

Session Configuration

expireinteger (int32)

Session Expiry

disconnectDelayinteger (int32)

Session Disconnect Delay

loggingSettingsLoggingSettings (object)

routesnullable array of Route (object)

RAS Ocelot routing configuration

downstreamPathTemplatenullable string

The path that the server will request

downstreamSchemenullable string

Protocol to use

downstreamHostAndPortsnullable array of EndPoint (object)

List of servers and ports where the RAS Performance Monitor is hosted.

hostnullable string

Server hosting RAS Performance Monitor

portinteger (int32)

Port where the server is hosting RAS Performance Monitor

upstreamPathTemplatenullable string

The URL on the RAS Web Admin service that will be redirected

Request

Response

Update

Modify the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

PUT/api/WebService/settings

Body

Web Admin settings

allowedHostsnullable string

Specifies the Allowed Hosts.

httpsUrlnullable string

Specifies the HTTPS URL.

enableWebConsolenullable boolean

Specifies whether to enable/disable Web Console.

webConsoleBasePathnullable string

Specifies the Web Console Base Path. The RAS Web Administration Server Service needs to be manually restarted for the BasePath change to be effective.

webConsolePollingIntervalnullable integer (int32)

Specifies the Web Console Polling Interval.

enableRESTnullable boolean

Specifies whether to enable/disable REST.

rasLicensingServernullable string

Specifies the RAS Licensing Server.

rasSecondaryServersnullable array of string

Specifies the RAS Secondary Servers.

itemsstring

sessionExpirenullable integer (int32)

Specifies the Session Expiry time in minutes.

sessionDisconnectDelaynullable integer (int32)

Specifies the Session Disconnect Delay in seconds.

Response

No Content

Request

Response

Version

Retrieve the version of the Remote Application Server Web Service.

GET/api/WebService/version

Response

Success

Request

Import Certificate

This can be used to Import and change the PFX Certificate within Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

PUT/api/WebService/settings/ImportCertificate

Body

CertificateFilestring (binary)

Upload File

Response

No Content

Request

Response

Update

Modify the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

PUT/api/WebService/settings

Body

Web Admin settings

allowedHostsnullable string

Specifies the Allowed Hosts.

httpsUrlnullable string

Specifies the HTTPS URL.

enableWebConsolenullable boolean

Specifies whether to enable/disable Web Console.

webConsoleBasePathnullable string

Specifies the Web Console Base Path. The RAS Web Administration Server Service needs to be manually restarted for the BasePath change to be effective.

webConsolePollingIntervalnullable integer (int32)

Specifies the Web Console Polling Interval.

enableRESTnullable boolean

Specifies whether to enable/disable REST.

rasLicensingServernullable string

Specifies the RAS Licensing Server.

rasSecondaryServersnullable array of string

Specifies the RAS Secondary Servers.

itemsstring

sessionExpirenullable integer (int32)

Specifies the Session Expiry time in minutes.

sessionDisconnectDelaynullable integer (int32)

Specifies the Session Disconnect Delay in seconds.

Response

No Content

Request

Response

Get

Retrieve the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.

GET/api/WebService/settings

Response

Success

Body

allowedHostsnullable string

Specifies the Allowed Hosts

kestrelKestrelConfig (object)

The Kestrel configuration

endPointsEndPointsConfig (object)

The endpoints configuration

httpsDefaultCertHttpsDefaultCertConfig (object)

The HTTPS default certificate configuration

urlnullable string

URL of the configuration

certificateCertificateConfig (object)

The Certificate Policy

pathnullable string

Path where the certificate lies.

encryptedPasswordnullable string

Encrypted Password of the certificate.

webAdminServiceWebAdminServiceConfig (object)

RAS Web Administration Service configuration

webConsoleWebConsoleConfig (object)

Web Console configuration

enableboolean

Whether the configuration is enabled or not.

basePathnullable string

Specifies the Web Console Base Path.

pollingIntervalinteger (int32)

Specifies the Web Console Polling Interval.

logLevelinteger (int32)

Specifies the Web Console Log Level.

restRESTConfig (object)

The REST configuration

enableboolean

Whether the REST configuration is enabled or not.

rasServerRASServerConfig (object)

The RAS server configuration

licenseServernullable string

RAS Licensing server

secondaryServersnullable array of string

List of secondary servers

itemsstring

sessionSessionConfig (object)

Session Configuration

expireinteger (int32)

Session Expiry

disconnectDelayinteger (int32)

Session Disconnect Delay

loggingSettingsLoggingSettings (object)

routesnullable array of Route (object)

RAS Ocelot routing configuration

downstreamPathTemplatenullable string

The path that the server will request

downstreamSchemenullable string

Protocol to use

downstreamHostAndPortsnullable array of EndPoint (object)

List of servers and ports where the RAS Performance Monitor is hosted.

hostnullable string

Server hosting RAS Performance Monitor

portinteger (int32)

Port where the server is hosting RAS Performance Monitor

upstreamPathTemplatenullable string

The URL on the RAS Web Admin service that will be redirected

Request

Response

const response = await fetch('/api/WebService/version', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/WebService/settings/ImportCertificate', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/WebService/settings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/WebService/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "allowedHosts": "text",
  "kestrel": {
    "endPoints": {
      "httpsDefaultCert": {
        "url": "text",
        "certificate": {
          "path": "text",
          "encryptedPassword": "text"
        }
      }
    }
  },
  "webAdminService": {
    "webConsole": {
      "enable": false,
      "basePath": "text"
    },
    "rest": {
      "enable": false
    },
    "rasServer": {
      "licenseServer": "text",
      "secondaryServers": [
        "text"
      ]
    },
    "session": {}
  },
  "routes": [
    {
      "downstreamPathTemplate": "text",
      "downstreamScheme": "text",
      "downstreamHostAndPorts": [
        {
          "host": "text"
        }
      ],
      "upstreamPathTemplate": "text"
    }
  ]
}