Skip to content

Commit fa58e88

Browse files
author
Niklas Empt
committed
update Documentation
1 parent 6c981f8 commit fa58e88

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/api/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,8 @@ Replace the TLS certificate and key on the fly. Reload is optional.
199199

200200
The certificates need to be base64 encoded as in the following example.
201201

202+
When updating the TLS certificate with a new certificate obtained by requesting a Certificate Signing Request (CSR) from the CSR Endpoint, the keydata field must be omitted. The certificate will only be updated if the public key associated with the new certificate matches the public key generated by the CSR Endpoint.
203+
202204
Example:
203205

204206
```bash
@@ -229,6 +231,7 @@ https://127.0.0.1:8443/api/v1/admin/csr
229231
```
230232

231233
Returns PEM encoded csr
234+
When NewKey:true is specified, a new private key will be generated and stored in a temporary file. This temporary file will be retained until you upload the signed certificate to the /api/v1/admin/certs/replace endpoint, at which point the new private key will be saved in the keyfile specified in the configuration
232235

233236
### /api/v1/admin/updates/install
234237

0 commit comments

Comments
 (0)