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 integration and connects to Synology DSM through DSM Web API over HTTPS on port 5001. No service agent is installed on Synology DSM.

What happens

  1. The appliance connects to Synology DSM through DSM Web API on port 5001.
  2. Select an exact certificate description in DSM. The integration validates the material and replaces the existing ID with its default flag or creates a new entry without making it default.
  3. Names and the unique entry are read back. For the default certificate, management HTTPS must serve the new leaf; other entries receive an informational management probe.

Technical details

Connection
The integration runs on the appliance, which connects over HTTPS to DSM Web API, port 5001. No service agent is installed.
Service ports
5001
What you need
Create an account in the administrators group in Control Panel > User & Group (User on DSM 6). Turn off 2-step verification for that account or supply OTP_CODE for the login. Use the DSM HTTPS address and port as the target (default 5001).
Platform
DSM 6+; ECDSA: DSM 7+
Actions
Discovery, Installation, Verification, Rollback
Integrations
synology-dsm-api 2.0.0
Note
  • DSM does not return the previous key. After a completed overwrite, deploy cannot restore the key automatically. Rollback needs previous certificate, key and optional chain and preserves the entry’s current assignments. DSM 6 uses RSA; ECDSA requires DSM 7+. Login needs two-step verification disabled or a valid OTP. The certificate chain consists of the intermediate certificates that link the server certificate to a root certificate the browser trusts.

Next steps