List DNS Zone Records

GET /dnszone/{zoneId}/records

List DNS Zone Records

cURL

curl --request GET \
  --url https://api.bunny.net/dnszone/{zoneId}/records \
  --header 'AccessKey: <api-key>'

import requests

url = "https://api.bunny.net/dnszone/{zoneId}/records"

headers = {"AccessKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/dnszone/{zoneId}/records', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bunny.net/dnszone/{zoneId}/records",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bunny.net/dnszone/{zoneId}/records"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("AccessKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bunny.net/dnszone/{zoneId}/records")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/dnszone/{zoneId}/records")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "Items": [
    {
      "Id": 123,
      "Ttl": 123,
      "Value": "<string>",
      "Name": "<string>",
      "Weight": 123,
      "Priority": 123,
      "Port": 123,
      "Flags": 123,
      "Tag": "<string>",
      "Accelerated": true,
      "AcceleratedPullZoneId": 123,
      "LinkName": "<string>",
      "IPGeoLocationInfo": {
        "CountryCode": "<string>",
        "Country": "<string>",
        "ASN": 123,
        "OrganizationName": "<string>",
        "City": "<string>"
      },
      "GeolocationInfo": {
        "Country": "<string>",
        "City": "<string>",
        "Latitude": 123,
        "Longitude": 123
      },
      "GeolocationLatitude": 123,
      "GeolocationLongitude": 123,
      "EnviromentalVariables": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ],
      "LatencyZone": "<string>",
      "Disabled": true,
      "Comment": "<string>",
      "AutoSslIssuance": true
    }
  ],
  "CurrentPage": 123,
  "TotalItems": 123,
  "HasMoreItems": true
}

{
  "ErrorKey": "<string>",
  "Field": "<string>",
  "Message": "<string>"
}

Authorizations

AccessKey · string · header · required

API Access Key authorization header

Path Parameters

zoneId · integer<int64> · required

The ID of the DNS Zone

Query Parameters

page · integer<int32> · default: 1

Required range: 1 <= x <= 2147483647

perPage · integer<int32> · default: 1000

Required range: 5 <= x <= 1000

Response

200

application/json

A paginated list of DNS records for the specified zone

Items · object[] | null

Show child attributes

CurrentPage · integer<int32>

TotalItems · integer<int32>

HasMoreItems · boolean