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

200401404

Success

Body

application/json; api-version=1.0

allowedHostsnullable string

Specifies the Allowed Hosts

kestrelKestrelConfig (object)

The Kestrel configuration

webAdminServiceWebAdminServiceConfig (object)

RAS Web Administration Service configuration

loggingSettingsLoggingSettings (object)

routesnullable array of Route (object)

RAS Ocelot routing configuration

Request

JavaScriptCurlPython

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

Response

200401404

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

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

application/json; api-version=1.0

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.

sessionExpirenullable integer (int32)

Specifies the Session Expiry time in minutes.

sessionDisconnectDelaynullable integer (int32)

Specifies the Session Disconnect Delay in seconds.

Response

204401404

No Content

Request

JavaScriptCurlPython

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();

Response

401404

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