Settings

Get

get

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

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/WebService/settings

HTTPcURLJavaScriptPython

GET /api/WebService/settings HTTP/1.1
Accept: */*

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

Update

put

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

Body

application/json; api-version=1.0

Update RAS Web Administration Service settings

allowedHostsstring · min: 1 · max: 255 · nullableOptional

Specifies the Allowed Hosts.

httpsUrlstring · nullableOptional

Specifies the HTTPS URL.

enableWebConsoleboolean · nullableOptional

Specifies whether to enable/disable Web Console.

webConsoleBasePathstring · min: 1 · max: 255 · nullableOptional

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

webConsolePollingIntervalinteger · int32 · nullableOptional

Specifies the Web Console Polling Interval.

enableRESTboolean · nullableOptional

Specifies whether to enable/disable REST.

rasLicensingServerstring · nullableOptional

Specifies the RAS Licensing Server.

rasSecondaryServersstring[] · nullableOptional

Specifies the RAS Secondary Servers.

sessionExpireinteger · int32 · nullableOptional

Specifies the Session Expiry time in minutes.

sessionDisconnectDelayinteger · int32 · nullableOptional

Specifies the Session Disconnect Delay in seconds.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/WebService/settings

HTTPcURLJavaScriptPython

PUT /api/WebService/settings HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 245

{
  "allowedHosts": "text",
  "httpsUrl": "text",
  "enableWebConsole": true,
  "webConsoleBasePath": "text",
  "webConsolePollingInterval": 1,
  "enableREST": true,
  "rasLicensingServer": "text",
  "rasSecondaryServers": [
    "text"
  ],
  "sessionExpire": 1,
  "sessionDisconnectDelay": 1
}

No content