Certificate
Supply (or remove) a certificate and private key to the API to allow SSL connections from outside of localhost (the machine the API is running on). Without this certificate, the API will only listen for connections on localhost:Port Number. Once a valid certificate and private key are provided, this will change to 0.0.0.0:Port Number. External connections (not from localhost) will only be allowed if they are SSL connections (HTTPS or Secure WebSockets).
The API does not make a copy of the certificate or private key. The user that the API is running as will need access to the files to be able to use them. This is all tested when the "set" command is issued and should provide sufficient error information if it does not work.
It is up to the user to supply a certificate that is suitable for their usage. For example, if it is not signed by a certificate authority, then you will need to deal with this, such as signing your certificate with your own certificate authority and adding that to your application or browser.
-
With Google Chrome you can use this guide.
-
With Firefox you can use this guide.
-
With Safari you can use this guide.
for other browsers refer to the browser supplier for more information.
Only a single certificate configuration is supported. If a password is supplied, it is stored and obfuscated for security.
| Method | Description |
|---|---|
| Add Certificate | Get the certificates assigned to the API |
| Remove Certificate | Set the certificate for the API |
| Get Certificate | Remove the certificate from the API |