Managed DNS apis

db122

I'm hoping to migrate over from provider known as "bulldozed acquisition target" and I'm just checking all of my use cases. One of these is a short dynamic DNS script that I run locally to update a DNS record periodically. I see that there is an API token available in the Control Panel, but I haven't been able to find any documentation of the APIs available.

Is updating the IP address in the managed DNS something that's doable?

Thanks!

sean

db122 Yes, completely doable!

We've actually just lit up our generated API docs (work-in-progress) in a couple of different formats:

We'll be putting out some tutorials and examples in our documentation in the coming weeks.

For now, if you're familiar with REST APIs, the method you want is dnsrecord/update. You have to pass an authorization header containing your API token, prefaced by the string Token.

Here's an example with curl:

curl  -X POST \
--header "Content-Type:application/json" \
--header "Authorization: Token API_TOKEN" \
--data '{"id":"DNS_UUID", "domain":"DOMAIN_UUID", "type":"A", "content": "IP_ADDRESS", "priority": 10, "ttl": 300  }' \
https://my.opalstack.com/api/v0/dnsrecord/update/

Replace API_TOKEN with your token.
Replace DNS_UUID with the UUID of the DNS record you want to update. You can get the UUID from the URL of whatever record in the control panel, or via the dns/list API method.
Replace DOMAIN_UUID with the UUID of the domain/subdomain for the A record. At the present time these aren't easily visible in the control panel, but you can see them in the page source at https://my.opalstack.com/domains/ or via the domain/list API method.
Replace IP_ADDRESS with the IP for the A record.

Also, our control panel is mostly a JS client for our API, so feel free to explore the page source in the various sections of the panel to see how it interacts with the API. 😃

db122

sean very cool, thanks a lot!

houdinihound

Can confirm this works great for setting a dynamic DNS record.

My python script version:

    headers = {'Authorization': f"Token {API_TOKEN}"}

    # Check the IP on Opalstack.
    resp = requests.get(f"https://my.opalstack.com/api/v0/dnsrecord/read/{DNS_UUID}", headers=headers)

    # Set the IP address on Opalstack.
    data = {"id"        : DNS_UUID,
            "domain"    : DOMAIN_UUID,
            "type"      :"A",
            "content"   : new_ip,
            "priority"  : 10,
            "ttl"       : 300
            }
    resp = requests.post('https://my.opalstack.com/api/v0/dnsrecord/update/', headers=headers, json=data)

HTH,

chad

This info in this thread was helpful. Thank you @sean and @houdinihound.

It helped me update my WebFaction dynamic DNS script to work with Opalstack.

📄 update_ip.py
https://gist.github.com/cvn/7ac82d2ba0f5fa569c4a360387d89438

The script is intended be run periodically using cron or as a Windows service. It aims to be efficient, and will only hit the Opalstack API when the IP changes.

mightyohm

@chad Your script is great! Thanks for posting this! However, the script broke this week. From what I can tell, the v0 API went away (URLs are no longer valid) and has been replaced by v1. Something with the API must have changed because just changing the URL's to point to the v1 API isn't enough to fix it. Have not had a chance to investigate further.

sean

mightyohm I think if you wrap update_data in a list then that should get it working again, eg:

    # Set the IP address on Opalstack.
    update_data = [{
        "id"        : dns_uuid,
        "domain"    : domain_uuid,
        "type"      : "AAAA" if ':' in current_ip else "A",
        "content"   : current_ip,
        "priority"  : 10,
        "ttl"       : 3600,
    }]

chad

I updated my script to use the v1 API.

I made different changes than the ones @sean did above, which affects the json file. If you used the changes above, and now want to update to my new version, I recommend deleting any json files from that folder first.

mightyohm and sean Thank you for working through this. It was a big help.

mightyohm

sean That fixed it, thanks!

Edit: spoke too soon, subsequent execution of the script fails with

if info.get('content') != current_ip: AttributeError: 'list' object has no attribute 'get'

sean

mightyohm Edit: spoke too soon, subsequent execution of the script fails with

if info.get('content') != current_ip:
AttributeError: 'list' object has no attribute 'get'

It's failing for a similar reason - the new result was saved as a list, but the code is expecting a dict when it reads the file from the previous run.

Try this, which uses info[0] to get the first item of the list info:

if info[0].get('content') != current_ip:

mightyohm

sean Excellent, seems to be working now. Thanks for the help!