Simply.com API documentation

You can find the HTTP endpoint on https://api.simply.com/2/ - prefix your requests with this.

Example: https://api.simply.com/2/my/products/

Authentication happens with HTTP Basic Authentication.

Username is the Simply.com Account-number (Sxxxxxx).

Password is the API-Key for that specific account.

Both the Account-number and API-Key assigned to your Simply.com account can be found in your Simply.com Controlpanel.

The API is subject to rate limits, only to prevent abuse.

You can see the limit and the consumption in the X-RateLimit-Limit and X-RateLimit-Remaining headers.

You can find the OpenAPI spec for the API here: https://api.simply.com/2/openapi.json.

Consider using the Swagger UI browser here: https://generator.swagger.io/.

The following libraries are availiable for use.

ACME implementations

acme.sh	https://github.com/acmesh-official/acme.sh/
Posh-ACME	https://github.com/rmbolger/Posh-ACME/
cert-manager service	https://github.com/RunnerM/simply-dns-webhook/
Certbot plugin	https://github.com/JohNan/certbot-dns-simply/

API implementations

PHP	https://github.com/simplycom/api-php/

This endpoint helps you easily set up DDNS on a domain.

Curl example (Recommended)

Use the following Curl command to set home.example.com to the external IP of the requesting client:

curl -s -u "ACCOUNTNAME:APIKEY" -X POST "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"

You can set this command to run in a crontab, on a local machine, every 15 minutes or so.

Synology

On Synology you can use the following syntax as Custom DDNS Provider

https://api.simply.com/2/ddns/?domain=example.com&hostname=__HOSTNAME__&myip=__MYIP__

hostname should then be provided as the full qualified domain name that you wish to update, i.e. home.example.com.

Home Assistant

# In configuration.yaml file
rest_command:
  simplycom_ddns:
    username: "ACCOUNTNAME"
    password: "APIKEY"
    url: "https://api.simply.com/2/ddns/?domain=example.com&hostname=home"

# Automation
alias: Simply.com DDNS
trigger:
- platform: time_pattern
minutes: "0"
seconds: "0"
action:
- service: rest_command.simplycom_ddns

Unifi

In UniFi OS you need to set up a Custom Dynamic DNS provider, and enter the following string in the "Server" field.

api.simply.com/2/ddns/?domain=example.com&hostname=%h&myip=