DNS APIv2beta1

The DNS API allows you to manage your DNS zones and records.

• Manage your domain with one or more zones
• Use Dynamic Records to optimize and ease your Infra As Code

A domain name is an identification string that defines a realm of administrative autonomy, authority or control within the Internet. Domain names are formed by the rules and procedures of the Domain Name System (DNS). Any name registered in the DNS is a domain name.

Domains are further divided into sub-domains, each becoming a DNS zone itself with its own set of administrators and DNS servers.

The term domain is used in the business functions of the entity assigned to it and the term zone is usually used for configuration of DNS services.

example.com is the domain and has only one owner who can manage it.

By default, the domain only has a root zone (no sub domain).

example.com zone allows the configuration of records such as:

example.com
├── (root)
    ├── www           # www.example.com
    ├── mail          # mail.example.com
    └── www.dev       # www.dev.example.com

If we add a DNS zone to the sub domain dev.example.com, we get:

example.com
├── (root)
│   ├── www           # www.example.com
│   └── mail          # mail.example.com
│
├── dev
    └── www           # www.dev.example.com

• Only the owner of the domain can use the domain services
• Each zone supports the creation of sub-zones, which inherit the parent's projectID

In the simplest case you will only need the root zone.

But multiple zones (i.e. sub-domains) allow:

• access delegation to zone(s) (preventing access to the root zone)
• (future) features based on templates
• performance tuning (for example if you have 10k records, it will be better to divide them into x zones / sub-domains)

Remark: to be RFC compliant, each zone will automatically have NS records added.

An internationalized domain name (IDN) is an Internet domain name that contains at least one label that is displayed in software applications, which is in whole or in part in a language-specific script or alphabet, such as Arabic, Chinese, Cyrillic, Tamil, Hebrew or the Latin alphabet-based characters with diacritics or ligatures, such as French. These writing systems are encoded by computers in multi-byte Unicode. Internationalized domain names are stored in the Domain Name System as ASCII strings using Punycode transcription.

Example: allélua.com converted in IDN is xn--alllua-dva.com.

To simplify its use, the DNS API uses unicode (UTF-8) for name and data fields.

Login to your Scaleway account and create a token from the credentials page. A secret_key and an access_key will be displayed on your screen, the secret_key will be used as X-Auth-Token.

Reference: https://www.scaleway.com/docs/generate-an-api-token/

The organization id is required to get the permissions. You will need to query:

curl https://account.scaleway.com/organizations -H "X-Auth-Token: $secret_key"

To get your organization id:

{
   "organizations":[
      {
         "id":"000a115d-2852-4b0a-9ce8-47f1134ba95a", <-----
         "name":"jsnow@got.wint",
         "users": [{}]
      }
   ]
}

Reference: https://www.scaleway.com/docs/retrieve-my-organization-id-throught-the-api/

curl -s --request GET \
  --url https://api.scaleway.com/domain/v2beta1

{
  "name": "Scaleway Name Service",
  "description": "Domain and DNS services",
  "version": "v2beta1",
  "documentation_url": "https://developers.scaleway.com/en/products/domain/api/"
}

To use Scaleway DNS to manage your Domain, you need to register your Domain with:

curl --request POST \
  --url http://api.scaleway.com/domain/v2beta1/domains/external-domain \
  --header 'content-type: application/json' \
  --header 'x-auth-token: xxxxxxx' \
  --data '{
  "domain": "domain-external.test",
  "project_id": "xxxxxx"
}

{
  "domain": "domain-external.test",
  "organization_id": "xxxxxx",
  "project_id": "xxxxxx",
  "validation_token": "0bb2c236-7d14-4ab3-8a6d-83d1b460a14b",
  "created_at": "2020-05-07T13:24:35Z"
}

You will then have 48h to set up a TXT record to confirm the ownership of the Domain:

• name : _scaleway-challenge
• content: the validation token

Upon validation you will receive a confirmation email and the Domain will be available on the API. You will then have to update the DNS servers at your registrar to point your Domain to Scaleway DNS servers: ns0.dom.scw.cloud and ns1.dom.scw.cloud.

curl --request GET \
  --url https://api.scaleway.com/domain/v2beta1/domains \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'

{
  "total_count": 1,
  "domains": [
    {
      "domain": "scaleway-test5.com",
      "organization_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx",
      "project_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx",
      "auto_renew_status": "feature_status_unknown",
      "dnssec_status": "feature_status_unknown",
      "epp_code": [],
      "expired_at": null,
      "updated_at": "1970-01-01T00:00:00Z",
      "registrar": "EXTERNAL",
      "is_external": true,
      "status": "active"
    }
  ]
}

curl --request GET \
  --url https://api.scaleway.com/domain/v2beta1/domains/scaleway-test5.com/zones \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'

{
  "total_count": 2,
  "dns_zones": [
    {
      "domain": "scaleway-test5.com",
      "subdomain": "",
      "ns_default": [],
    },
    {
      "domain": "scaleway-test5.com",
      "subdomain": "test-zone",
      "ns_default": [],
    }
  ]
}

curl --request GET \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/ \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'

{
  "total_count": 3,
  "dns_zones": [
    {
      "domain": "scaleway-test5.com",
      "subdomain": "",
      "ns_default": [],
    },
    {
      "domain": "scaleway-test5.com",
      "subdomain": "test-zone",
      "ns_default": [],
    },
    {
      "domain": "testscaleway-test5.com",
      "subdomain": "test-zone3",
      "ns_default": [],
    }
  ]
}

curl --request GET \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/subdomain.scaleway-test5.com/records \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'

{
  "total_count": 2,
  "records": [
    {
      "data": "ns0.online.net.",
      "name": "",
      "priority": 0,
      "ttl": 0,
      "type": "NS",
      "comment": null
    },
    {
      "data": "ns1.online.net.",
      "name": "",
      "priority": 0,
      "ttl": 0,
      "type": "NS",
      "comment": null
    }
}

Remarks:

• The clear operation clears all the records (thus allows to restart from scratch)
• The operation works the same as PowerDns patch
• If the zone does not exist but is included in a managed zone, the API will create the new (sub) zone

curl --request PATCH \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/subdomain.scaleway-test5.com/records \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx' \
  --data '{
    "changes": [
      {
        "clear": {}
      },
      {
        "add": {
          "records": [
            {
              "name": "test1",
              "data": "127.0.0.1",
              "type": "A",
              "ttl": 3600
            },
            {
              "name": "test2",
              "data": "127.0.0.1",
              "type": "A",
              "ttl": 3600
            }
          ]
        }
      },
      {
        "set": {
          "id_fields": {
            "type": "A",
            "name": "test2"
          },
          "records": [
            {
              "name": "test2",
              "data": "127.0.0.2",
              "type": "A",
              "ttl": 3600
            }
          ]
        }
      },
      {
        "add": {
          "records": [
            {
              "name": "test3",
              "data": "127.0.0.3",
              "type": "A",
              "ttl": 3600
            },
            {
              "name": "test3",
              "data": "127.0.0.4",
              "type": "A",
              "ttl": 3600
            }
          ]
        }
      },
      {
        "delete": {
          "id_fields": {
            "name": "test3",
            "data": "127.0.0.4",
            "type": "A",
            "ttl": 3600
          }
        }
      }
    ]
  }'


{
  "records": [
    {
      "id": "<UUID>",
      "data": "127.0.0.1",
      "name": "test1",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    },
    {
      "id": "<UUID>",
      "data": "127.0.0.1",
      "name": "test2",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    },
    {
      "id": "<UUID>",
      "data": "127.0.0.2",
      "name": "test2",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    },
    {
      "id": "<UUID>",
      "data": "127.0.0.3",
      "name": "test3",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    }
  ]
}

We provide the classic record types (A, AAAA, CNAME...) along with some dynamic records. At the moment the following dynamic records are supported: http(s) health checks and views.

Service up

This will test if a (http/https) service is up on a provided list of IPs.

An IP is considered healthy if the query response contains the text specified in must_contain.

The Record Type can be one of:

• A
• AAAA

curl --request PATCH \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/dom.internal.scaleway.com/records \
  --header 'content-type: application/json' \
  --header 'x-auth-token: xxxx' \
  --data '{
    "return_all_records": false,
    "changes": [
      {
        "add": {
          "records": [
            {
              "name": "service-www",
              "data": "10.51.2.8",
              "type": "A",
              "ttl": 600,
              "http_service_config": {
                "ips": [
                  "10.51.2.8",
                  "10.51.3.7",
                  "10.51.2.9"
                ],
                "must_contain": "I am fine",
                "url": "https://www.domain-test.test"
              }
            }
          ]
        }
      }
    ]
}'

View

View will give responses depending on the requester (or resolver) IP.

Record Type can be:

• A
• AAAA
• CNAME
• TXT

curl --request PATCH \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/dom.internal.scaleway.com/records \
  --header 'content-type: application/json' \
  --header 'x-auth-token: xxxxx' \
  --data '{
    "return_all_records": false,
    "changes": [
      {
        "set": {
          "id_fields": {
            "name": "test",
            "type": "CNAME"
          },
          "records": [
            {
              "name": "test",
              "data": "default-domain.com.",
              "type": "CNAME",
              "ttl": 600,
              "view_config": {
                "views": [
                  {
                    "subnet": "10.51.0.0/16",
                    "data": "filtered-domain.com."
                  }
                ]
              }
            }
          ]
        }
      }
    ]
}'

curl --request GET \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/subdomain.scaleway-test5.com/records \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'


{
  "total_count": 3,
  "records": [
    {
      "data": "<UUID>",
      "data": "127.0.0.1",
      "name": "test1",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    },
    {
      "data": "<UUID>",
      "data": "127.0.0.2",
      "name": "test2",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    },
    {
      "data": "<UUID>",
      "data": "127.0.0.3",
      "name": "test3",
      "priority": 0,
      "ttl": 3600,
      "type": "A"
    }
  ]
}

Delete the zone AND all the records, NS included:

curl --request DELETE \
  --url https://api.scaleway.com/domain/v2beta1/dns-zones/subdomain.scaleway-test5.com/records \
  --header 'x-auth-token: xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx'

{}

Returns a list of manageable DNS zones. You can filter the DNS zones by domain name.

Create a new DNS zone.

Update the name and/or the organizations for a DNS zone.

Delete a DNS zone and all it's records.

Clone an existed DNS zone with all its records into a new one.

Refresh SOA DNS zone. You can recreate the given DNS zone and its sub DNS zone if needed.

Get the DNS zone TSIG Key to allow AXFR request.

Returns a list of Nameservers and their optional glue records for a DNS zone.

Update DNS zone nameservers and set optional glue records.

Returns a list of DNS records of a DNS zone with default NS. You can filter the records by type and name.

Only available with default NS.
Send a list of actions and records.

Action can be:

• add:
• Add new record
• Can be more specific and add a new IP to an existing A record for example
• set:
• Edit a record
• Can be more specific and edit an IP from an existing A record for example
• delete:
• Delete a record
• Can be more specific and delete an IP from an existing A record for example
• clear:
• Delete all records from a DNS zone

All edits will be versioned.