Records

Download schema

A DNS record holds information translating a domain or subdomain to an IP address, mail server or other domain/subdomain.

List name servers within a DNS zone

GET

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/nameservers

Retrieve a list of name servers within a DNS zone and their optional glue records.

List name servers within a DNS zone › path Parameters

dns_zone

string · required

DNS zone on which to filter the returned DNS zone name servers.

List name servers within a DNS zone › query Parameters

project_id

string

Project ID on which to filter the returned DNS zone name servers.

List name servers within a DNS zone › Responses

200

scaleway.domain.v2beta1.ListDNSZoneNameserversResponse

scaleway.domain.v2beta1.Nameserver[]

DNS zone name servers returned.

Update name servers within a DNS zone

PUT

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/nameservers

Update name servers within a DNS zone and set optional glue records.

Update name servers within a DNS zone › path Parameters

dns_zone

string · required

DNS zone in which to update the DNS zone name servers.

Update name servers within a DNS zone › Request Body

scaleway.domain.v2beta1.Nameserver[] · required

New DNS zone name servers.

Update name servers within a DNS zone › Responses

200

scaleway.domain.v2beta1.UpdateDNSZoneNameserversResponse

scaleway.domain.v2beta1.Nameserver[]

DNS zone name servers returned.

List records within a DNS zone

GET

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name.

List records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone on which to filter the returned DNS zone records.

List records within a DNS zone › query Parameters

name

string · required

Name on which to filter the returned DNS zone records.

project_id

string

Project ID on which to filter the returned DNS zone records.

order_by

string · enum

Sort order of the returned DNS zone records.

Enum values:

name_asc

name_desc

Default: name_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of DNS zone records per page.

type

string · enum

Record type on which to filter the returned DNS zone records.

Enum values:

unknown

AAAA

CNAME

TXT

SRV

TLSA

Default: unknown

id

string

Record ID on which to filter the returned DNS zone records.

List records within a DNS zone › Responses

200

scaleway.domain.v2beta1.ListDNSZoneRecordsResponse

total_count

integer · uint32

Total number of DNS zone records.

scaleway.domain.v2beta1.Record[]

Paginated returned DNS zone records.

GET/domain/v2beta1/dns-zones/{dns_zone}/records

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/domain/v2beta1/dns-zones/{dns_zone}/records?name=string"

Example Responses

{
  "total_count": 0,
  "records": [
    {
      "data": "data",
      "name": "name",
      "priority": 0,
      "ttl": 0,
      "type": "unknown",
      "comment": "comment",
      "geo_ip_config": {
        "matches": [
          {
            "countries": [
              "string"
            ],
            "continents": [
              "string"
            ],
            "data": "data"
          }
        ],
        "default": "default"
      },
      "http_service_config": {
        "ips": [
          "1.2.3.4"
        ],
        "must_contain": "must_contain",
        "url": "url",
        "user_agent": "user_agent",
        "strategy": "random"
      },
      "weighted_config": {
        "weighted_ips": [
          {
            "ip": "1.2.3.4",
            "weight": 0
          }
        ]
      },
      "view_config": {
        "views": [
          {
            "subnet": "subnet",
            "data": "data"
          }
        ]
      },
      "id": "id",
      "updated_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

Clear records within a DNS zone

DELETE

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Delete all records within a DNS zone that has default name servers.
All edits will be versioned.

Clear records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone to clear.

Clear records within a DNS zone › Responses

200

scaleway.domain.v2beta1.ClearDNSZoneRecordsResponse

Update records within a DNS zone

PATCH

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Update records within a DNS zone that has default name servers and perform several actions on your records.

Actions include:

add: allows you to add a new record or add a new IP to an existing A record, for example
set: allows you to edit a record or edit an IP from an existing A record, for example
delete: allows you to delete a record or delete an IP from an existing A record, for example
clear: allows you to delete all records from a DNS zone

All edits will be versioned.

Update records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone in which to update the DNS zone records.

Update records within a DNS zone › Request Body

scaleway.domain.v2beta1.RecordChange[] · required

Changes made to the records.

return_all_records

boolean

Specifies whether or not to return all the records.

disallow_new_zone_creation

boolean

Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default.

serial

integer · uint64

Use the provided serial (0) instead of the auto-increment serial.

Update records within a DNS zone › Responses

200

scaleway.domain.v2beta1.UpdateDNSZoneRecordsResponse

scaleway.domain.v2beta1.Record[]

DNS zone records returned.

PATCH/domain/v2beta1/dns-zones/{dns_zone}/records

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"changes":[""],"disallow_new_zone_creation":false}' \
  "https://api.scaleway.com/domain/v2beta1/dns-zones/{dns_zone}/records"

Example Request Body

{
  "changes": [
    {
      "add": {
        "records": [
          {
            "data": "data",
            "name": "name",
            "priority": 0,
            "ttl": 0,
            "type": "unknown",
            "comment": "comment",
            "geo_ip_config": {
              "matches": [
                {
                  "countries": [
                    "string"
                  ],
                  "continents": [
                    "string"
                  ],
                  "data": "data"
                }
              ],
              "default": "default"
            },
            "http_service_config": {
              "ips": [
                "1.2.3.4"
              ],
              "must_contain": "must_contain",
              "url": "url",
              "user_agent": "user_agent",
              "strategy": "random"
            },
            "weighted_config": {
              "weighted_ips": [
                {
                  "ip": "1.2.3.4",
                  "weight": 0
                }
              ]
            },
            "view_config": {
              "views": [
                {
                  "subnet": "subnet",
                  "data": "data"
                }
              ]
            },
            "id": "id",
            "updated_at": "2022-03-22T12:34:56.123456Z"
          }
        ]
      },
      "set": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "id_fields": {
          "name": "name",
          "type": "unknown",
          "data": "data",
          "ttl": 0
        },
        "records": [
          {
            "data": "data",
            "name": "name",
            "priority": 0,
            "ttl": 0,
            "type": "unknown",
            "comment": "comment",
            "geo_ip_config": {
              "matches": [
                {
                  "countries": [
                    "string"
                  ],
                  "continents": [
                    "string"
                  ],
                  "data": "data"
                }
              ],
              "default": "default"
            },
            "http_service_config": {
              "ips": [
                "1.2.3.4"
              ],
              "must_contain": "must_contain",
              "url": "url",
              "user_agent": "user_agent",
              "strategy": "random"
            },
            "weighted_config": {
              "weighted_ips": [
                {
                  "ip": "1.2.3.4",
                  "weight": 0
                }
              ]
            },
            "view_config": {
              "views": [
                {
                  "subnet": "subnet",
                  "data": "data"
                }
              ]
            },
            "id": "id",
            "updated_at": "2022-03-22T12:34:56.123456Z"
          }
        ]
      },
      "delete": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "id_fields": {
          "name": "name",
          "type": "unknown",
          "data": "data",
          "ttl": 0
        }
      },
      "clear": {}
    }
  ],
  "return_all_records": true,
  "disallow_new_zone_creation": true,
  "serial": 0
}

json

Example Responses

{
  "records": [
    {
      "data": "data",
      "name": "name",
      "priority": 0,
      "ttl": 0,
      "type": "unknown",
      "comment": "comment",
      "geo_ip_config": {
        "matches": [
          {
            "countries": [
              "string"
            ],
            "continents": [
              "string"
            ],
            "data": "data"
          }
        ],
        "default": "default"
      },
      "http_service_config": {
        "ips": [
          "1.2.3.4"
        ],
        "must_contain": "must_contain",
        "url": "url",
        "user_agent": "user_agent",
        "strategy": "random"
      },
      "weighted_config": {
        "weighted_ips": [
          {
            "ip": "1.2.3.4",
            "weight": 0
          }
        ]
      },
      "view_config": {
        "views": [
          {
            "subnet": "subnet",
            "data": "data"
          }
        ]
      },
      "id": "id",
      "updated_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

DNS Zones Versions

List name servers within a DNS zone

GET

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/nameservers

Retrieve a list of name servers within a DNS zone and their optional glue records.

List name servers within a DNS zone › path Parameters

dns_zone

string · required

DNS zone on which to filter the returned DNS zone name servers.

List name servers within a DNS zone › query Parameters

project_id

string

Project ID on which to filter the returned DNS zone name servers.

List name servers within a DNS zone › Responses

200

scaleway.domain.v2beta1.ListDNSZoneNameserversResponse

scaleway.domain.v2beta1.Nameserver[]

DNS zone name servers returned.

Update name servers within a DNS zone

PUT

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/nameservers

Update name servers within a DNS zone and set optional glue records.

Update name servers within a DNS zone › path Parameters

dns_zone

string · required

DNS zone in which to update the DNS zone name servers.

Update name servers within a DNS zone › Request Body

scaleway.domain.v2beta1.Nameserver[] · required

New DNS zone name servers.

Update name servers within a DNS zone › Responses

200

scaleway.domain.v2beta1.UpdateDNSZoneNameserversResponse

scaleway.domain.v2beta1.Nameserver[]

DNS zone name servers returned.

List records within a DNS zone

GET

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Retrieve a list of DNS records within a DNS zone that has default name servers. You can filter records by type and name.

List records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone on which to filter the returned DNS zone records.

List records within a DNS zone › query Parameters

name

string · required

Name on which to filter the returned DNS zone records.

project_id

string

Project ID on which to filter the returned DNS zone records.

order_by

string · enum

Sort order of the returned DNS zone records.

Enum values:

name_asc

name_desc

Default: name_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of DNS zone records per page.

type

string · enum

Record type on which to filter the returned DNS zone records.

Enum values:

unknown

AAAA

CNAME

TXT

SRV

TLSA

Default: unknown

id

string

Record ID on which to filter the returned DNS zone records.

List records within a DNS zone › Responses

200

scaleway.domain.v2beta1.ListDNSZoneRecordsResponse

total_count

integer · uint32

Total number of DNS zone records.

scaleway.domain.v2beta1.Record[]

Paginated returned DNS zone records.

Clear records within a DNS zone

DELETE

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Delete all records within a DNS zone that has default name servers.
All edits will be versioned.

Clear records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone to clear.

Clear records within a DNS zone › Responses

200

scaleway.domain.v2beta1.ClearDNSZoneRecordsResponse

Update records within a DNS zone

PATCH

https://api.scaleway.com

/domain/v2beta1/dns-zones/{dns_zone}/records

Update records within a DNS zone that has default name servers and perform several actions on your records.

Actions include:

add: allows you to add a new record or add a new IP to an existing A record, for example
set: allows you to edit a record or edit an IP from an existing A record, for example
delete: allows you to delete a record or delete an IP from an existing A record, for example
clear: allows you to delete all records from a DNS zone

All edits will be versioned.

Update records within a DNS zone › path Parameters

dns_zone

string · required

DNS zone in which to update the DNS zone records.

Update records within a DNS zone › Request Body

scaleway.domain.v2beta1.RecordChange[] · required

Changes made to the records.

return_all_records

boolean

Specifies whether or not to return all the records.

disallow_new_zone_creation

boolean

Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default.

serial

integer · uint64

Use the provided serial (0) instead of the auto-increment serial.

Update records within a DNS zone › Responses

200

scaleway.domain.v2beta1.UpdateDNSZoneRecordsResponse

scaleway.domain.v2beta1.Record[]

DNS zone records returned.