Dynamix Documentation

Generic

Custom domains must be configured to use ns1.dynamix.run and ns2.dynamix.run as their name servers.

Thanks to wildcard DNS support, all additional subdomains will resolve to the configured main subdomain or domain IP address.  For example, if you registered the subdomain of "home.dynx.me", "serv1.home.dynx.me" will also resolve to the IP address stored in the database.

As an advanced option, other domains can be configured to use ns1.{yoursubdomain} and ns2.{yoursubdomain} (or ns1.{yourCustomDomain} and ns2.{yourCustomDomain}) as their name servers and have their DNS resolve through your home server (requires DNS server software - install EHCP Force Edition which sets up everything for you and supports Dynamic IP addresses).

The video below shows you how to use Dynamix and configure a subdomain to display your own custom website.

Dynamix API

Dynamix offers a powerful and secure dynamic DNS API that allows you to easily update and point your dynamic DNS domain and subdomain records to new IP addresses.  If your IP address changes frequently, the API can be used to update your records to point to your new address seamlessly.  Program your own software to use these endpoints to add, remove, and update dynamic DNS entries, or use our official Linux and Windows applications.

The API returns plain text results that can be easily parsed and captured by any software.

The API requires a user or customer key to perform actions.  Your user API key can be retrieved from the Dynamic DNS page.  Customer keys can be retrieved by pro or business users from the Users Page

Parameters shown in parenthesis in the endpoint URLs are optional.  If they are included, parenthesis should NOT be included in the request!

User API Endpoints

IPv4 and IPv6 IP addresses are valid for the "ip" parameter.

Dynamix offers the below user endpoints and API actions:

• update
• add
• remove
• getHosts
• changeKey

update

https://dynamix.run/api/public_api.php?key={USER_KEY}&action=ddns&subaction=update&subdomain=x&domain=domain.com(&ip=x.x.x.x)

The subdomain and ip parameters are optional.  If the ip parameter is omitted, the IP address of the requester will be used.  If you're using a custom domain, you may not be using a subdomain, which is why this parameter is optional.  If no changes are detected, nothing will change.

This endpoint is used to update the IP addresses for existing subdomain and domain dynamic DNS entries.  This is the endpoint that should be called after your IP address changes to update the DNS record to point to your current IP address.

Returns:

• 0 on generic failure or no change.
• error={error_message} if error is encountered.
• 1 on success.

add

https://dynamix.run/api/public_api.php?key={USER_KEY}&action=ddns&subaction=add&subdomain=x&domain=domain.com(&ip=x.x.x.x)

The subdomain and ip parameters are optional.  If omitted, the IP address of the requester will be used.  If no changes are detected, nothing will change.

This endpoint is used to add additional subdomain and domain dynamic DNS entries to your account.  As long as your account is under the limit and the requested subdomain (optional) and domain combo are not already in use, the call should succeed.

Returns:

• 0 on generic failure.
• error={error_message} if the requested combo exists or error is encountered.
• 1 on success.

remove

https://dynamix.run/api/public_api.php?key={USER_KEY}&action=ddns&subaction=remove&subdomain=x&domain=domain.com

The subdomain parameter is optional.

This endpoint is used to delete subdomain and domain dynamic DNS entries from your account.

Returns:

• 0 on generic failure.
• 1 on success.

getHosts

https://dynamix.run/api/public_api.php?key={USER_KEY}&action=ddns&subaction=getHosts

This endpoint is used to retrieve a list of dynamic host entries from the specified user account.

Returns:

• 0 on generic failure.
• Multiple lines of dynamic hosts on success.

changeKey

https://dynamix.run/api/public_api.php?key={USER_KEY}&action=changeKey

This endpoint is used to get a new user key for free accounts.  Accounts belonging to a customer or pro user cannot change their keys.

Returns:

• 0 on generic failure.
• {NEW_USER_KEY} on success.

Customer API Endpoints

Dynamix offers the below customer and pro user endpoints and API actions:

• createUser
• deleteUser
• suspendUser
• unsuspendUser
• changeKey

createUser

https://dynamix.run/api/public_api.php?key={CuSTOMER_KEY}&action=manage&subaction=createUser(&user_login={DESIRED_USER_LOGIN}&user_email={EMAIL_ADDRESS}&user_first_name={USER_FIRST_NAME}&user_password={DESIRED_USER_PASSWORD})

The user_login, user_email, user_first_name, and user_password parameters are optional.

This endpoint is used to add a new user to your customer account.  The new user's account key will be used upon successful creation, and this key can then be used to add, update, or remove dynamic DNS entries associated with this new user.

Returns:

• 0 on generic failure or no change.
• error={error_message} if the requested combo exists or another error is encountered.
• {USER_KEY} on success which should be stored and saved somewhere since other calls will require the usage of this key.

deleteUser

https://dynamix.run/api/public_api.php?key={CUSTOMER_KEY}&action=manage&subaction=deleteUser&user_key={USER_KEY_FOR_ACCOUNT_DELETE}

This endpoint is used to delete a customer user account.  This will delete the user record completely, delete any subdomain / domain entries, and is unrecoverable.

Returns:

• 0 on generic failure.
• 1 on success.

suspendUser

https://dynamix.run/api/public_api.php?key={CUSTOMER_KEY}&action=manage&subaction=suspendUser&user_key={USER_KEY_FOR_ACCOUNT_TO_SUSPEND}

This endpoint is used to suspend a customer user account.  Suspended accounts can no longer login (if a login and password were provided when the account was created) and configured subdomain / domain DNS entries will no longer work (but are still assigned to the user and cannot be registered by other users).  You could use this endpoint if your end users fail to pay their bills for example.

Returns:

• 0 on generic failure.
• 1 on success.

unsuspendUser

https://dynamix.run/api/public_api.php?key={CUSTOMER_KEY}&action=manage&subaction=suspendUser&user_key={USER_KEY_FOR_ACCOUNT_TO_UNSUSPEND}

This endpoint is used to unsuspend a customer user account.  Unsuspended accounts can login (if a login and password were provided when the account was created) and configured subdomain / domain DNS entries will be reactivated and will work properly.  Use this endpoint to unsuspend suspended users.

Returns:

• 0 on generic failure.
• 1 on success.

changeKey

https://dynamix.run/api/public_api.php?key={CUSTOMER_KEY}&action=changeKey

This endpoint is used to get a new customer key.

Returns:

• 0 on generic failure.
• {NEW_CUSTOMER_KEY} on success.