Simply.com API documentation

This document describes the Simply.com RESTful JSON API.

API endpoint

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

Authentication happens with HTTP Basic Authentication.

Username is the account-name and password is the API-KEY for the specific account.

The API-Key assigned to your Simply.com account can be found in your Simply.com Controlpanel.

OpenApi Spec / Documentation

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/.

Library implementations

Examples

POST /ddns/ - DDNS helper

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

Curl example

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"

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/?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.