Skip to content

← All integrations

Storage and virtualisation

Uploads the certificate to DSM and replaces the existing one with the same description.

The appliance runs the package and connects to Synology DSM through DSM Web API over HTTPS on port 5001. No agent is installed on Synology DSM.

What happens

  1. The appliance connects to Synology DSM through DSM Web API on port 5001.
  2. The certificate is uploaded and replaces the one with the same description, or is created. If it fails: Rollback uploads the previous certificate again. It needs the previous certificate and key, as DSM does not hand out keys.
  3. Verification: the package checks that the certificate exists in DSM.

Technical details

Connection
The package runs on the appliance, which connects over HTTPS to DSM Web API, port 5001. No agent is installed.
You need
DSM administrator allowed to manage certificates.
Platform
DSM 6 and later
Actions
Discovery, Installation, Verification, Rollback
Packages
synology-dsm-api 1.3.0
Note
  • DSM 6 requires RSA with 2048, 3072 or 4096 bits. DSM 7 and later also accept ECDSA P-256/P-384. The agent reads the DSM version and checks the certificate public key and key match before upload. ECDSA requires a discovered DSM version of at least 7.0; RSA 2048/3072/4096 can be installed when version information is unavailable. Run discovery again after upgrading the agent or DSM so the discovered version is used for key selection. Rollback restores the previous certificate without the new version check.
  • Synology: https://kb.synology.com/en-nz/DSM/tutorial/How_to_create_certificate_signing; https://kb.synology.com/en-global/DSM/help/DSM/AdminCenter/connection_certificate?version=7

Get started