GET /system/web-server/protocols/https
This resource allows you to enable the secure Webserver on this controller. Connections to this server are encrypted which helps to prevent eavesdropping thereby keeping passwords secure.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
Object Name: Protocol
| Property Name | Type | Description | Method |
|---|---|---|---|
| Port | Integer | Set the port numbers that the secure (https) or standard (http) Webservers are to use. | GET POST |
| Enabled | Boolean | Set this to enable the secure (https) or standard (http) Webserver on this controller. | GET POST |
| Certificate | Object | This object is used only with the HTTPS mode. It will remain empty for HTTP. It represents all the information about the current active certificate. | GET |
| Name | String | This is the name of the protocol. | GET |
| NLightChannels | Array<NLightChannel> | This is an array of NLightChannel. It will contains all the existing channels. |
GET |
URL Example: https://0.0.0.0/api/rest/v1/system/web-server/protocols/https
{
"port": 443,
"enabled": true,
"certificate": {
"href": "/api/rest/v1/system/web-server/protocols/https/certificate",
"name": "certificate"
},
"name": "https"
}
URL Example: https://0.0.0.0/api/rest/v1/system/web-server/protocols/https
<?xml version="1.0" encoding="utf-8"?>
<Protocol>
<Name>https</Name>
<Enabled>true</Enabled>
<Port>443</Port>
<Certificate>
<Href>
/api/rest/v1/system/web-server/protocols/https/certificate
</Href>
<Name>certificate</Name>
</Certificate>
</Protocol>