POST /system/web-server/protocols/https/certificate
This resource is used to handle the HTTPS certification.
For HTTPS connections, a certificate must have the controller’s current URL or IP address encoded into it to show to the connecting device that the connection corresponds to the certificate.
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.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: Certificate
| Property Name | Type | Description | Method |
|---|---|---|---|
| CommonName | String | For HTTPS connections, a certificate must have the controller’s current URL or IP address encoded into it to show the connecting device that the connection corresponds to the certificate. Set the controller’s current IP address, hostname, or DNS name. | GET POST |
| IsCustom | Boolean | True if a custom certificate is used. False if a custom certificate is not used. | GET POST |
| CustomStatus | String | This property correspond to the states of the custom certificate. There is multiple states :
|
GET |
| CustomPassword | String | The password for the imported certificate. It has to be encoded in Base64. |
POST |
URL Example: https://0.0.0.0/api/rest/v1/system/web-server/protocols/https/certificate
{
"isCustom": true,
"customStatus": "KO",
"commonName": "172.16.254.1"
}
URL Example: https://0.0.0.0/api/rest/v1/system/web-server/protocols/https/certificate
<?xml version="1.0" encoding="utf-8"?>
<Certificate>
<IsCustom>true</IsCustom>
<CommonName>172.16.254.1</CommonName>
<CustomStatus>KO</CustomStatus>
</Certificate>