Get DNS record from CloudFlare API

CloudFlare_DDNS_2.md

Let's try to ask DNS record for CloudFlare API.

Replace the "API Token" at auth_key by the API Token you get, the "Zone ID" can be found in Cloudflare Dashboard, logged in the Cloudflare Dashboard, check the Domain page, "Zone ID" information will appearance at API block, right hand side.

import json
import requests

cloudflare_api = "https://api.cloudflare.com/client/v4/"
zone_id = "278035ad7a9d983bc54a990b43ef7eb0"
auth_key = "API Token"
headers = {'Authorization': auth_key, 'Content-Type':'application/json'}

cloudflare_dns = cloudflare_api + "zones/" + zone_id + "/dns_records"  
cloudflare_dns_respon = requests.get(cloudflare_dns, headers=headers)

if cloudflare_dns_respon.status_code == 200:
    print("Ok")
else:
    print(cloudflare_dns_respon.status_code)    

dns_data = json.loads(cloudflare_dns_respon.text)

If the request send successfully, the result will print.

Ok

Then, the JSON data(dns_data) it respon will be like this:

{'result': [{'id': '3f7a9d18e117a65860dc5e2f2abdd191',
   'zone_id': '278035ad7a9d983bc54a990b43ef7eb0',
   'zone_name': 'lewd.dream',
   'name': 'lewd.dream',
   'type': 'A',
   'content': '114.514.19.19',
   'proxiable': True,
   'proxied': True,
   'ttl': 1,
   'locked': False,
   'meta': {'auto_added': False,
    'managed_by_apps': False,
    'managed_by_argo_tunnel': False,
    'source': 'primary'},
   'created_on': '2020-08-24T03:30:28.114514Z',
   'modified_on': '2020-08-24T03:30:28.114514Z'},
  {'id': 'ec8b33016fccf46dc8969316578974d7',
   'zone_id': '278035ad7a9d983bc54a990b43ef7eb0',
   'zone_name': 'lewd.dream',
   'name': 'midsummer-s.lewd.dream',
   'type': 'AAAA',
   'content': '8930:8100:1145:141:919:36:114:514',
   'proxiable': True,
   'proxied': False,
   'ttl': 1,
   'locked': False,
   'meta': {'auto_added': False,
    'managed_by_apps': False,
    'managed_by_argo_tunnel': False,
    'source': 'primary'},
   'created_on': '2020-08-24T03:43:46.114514Z',
   'modified_on': '2020-08-24T03:43:46.114514Z'}],
 'success': True,
 'errors': [],
 'messages': [],
 'result_info': {'page': 1,
  'per_page': 20,
  'count': 2,
  'total_count': 2,
  'total_pages': 1}}

doesn't work, it throws

{"success":false,"errors":[{"code":9106,"message":"Missing X-Auth-Key, X-Auth-Email or Authorization headers"}]}

doesn't work, it throws

{"success":false,"errors":[{"code":9106,"message":"Missing X-Auth-Key, X-Auth-Email or Authorization headers"}]}

@Suncatcher
You need to change 'Authorization' to 'X-Auth-Key' and add 'X-Auth-Email' to the header. This worked for me.

headers = {'X-Auth-Key': auth_key, 'Content-Type':'application/json', 'X-Auth-Email': 'your@email'}

Doesn't handle pagination

You need to change 'Authorization' to 'X-Auth-Key' and add 'X-Auth-Email' to the header. This worked for me.

now after your edits it throws

{"success":false,"errors":[{"code":10000,"message":"Authentication error"}]}

Checked twice the zone id, API token and email, they are correct. Any suggestions?

I had the same issue and came across this post.

There is a difference between between API Key and API Token, if you have a token that you'd like to use, you need to set the authorization header with bearer token.

I used curl with --header 'Authorization: Bearer < API TOKEN >'

Hi, appreciate everyone's response and troubleshooting.

- For safety reason, I will recommend using API Token instead of legacy API Keys.
+ Token with Bearer prefix  more safety, it can modify token’s permissions

Also, according to Cloudflare API Doc, Global API is only available after the account email address is verified.

This gist was only a demonstration of code writing years ago, please move to my GitHub repository Python-Cloudflare-DDNS.

I'll start working on code enhancement ASAP.

This works great for me.

curl --request GET \
--url https://api.cloudflare.com/client/v4/zones/XXXXX/dns_records?name=example.com \
--header 'Content-Type: application/json' \
--header 'X-Auth-Email: [email protected]' \
--header 'X-Auth-Key: XXXXXX' \
> "CF-DNS-Records-Fetch-on-$(date +'%m%d-%H%M%S').json"

Ref: Cloudflare API - Using Cloudflare’s API, you can do just about anything you can do on cloudflare.com via the customer dashboard.

This works great for me.

curl --request GET
--url https://api.cloudflare.com/client/v4/zones/XXXXX/dns_records?name=example.com
--header 'Content-Type: application/json'
--header 'X-Auth-Email: [email protected]'
--header 'X-Auth-Key: XXXXXX' \

"CF-DNS-Records-Fetch-on-$(date +'%m%d-%H%M%S').json"

doesn't work on Windows curl even without backslashes, being one-liner

C:\Users\user\Downloads>curl --request GET --url https://api.cloudflare.com/client/v4/zones/y89f78ds7f8ds7f8s7df8/dns_records?name=url.com --header 'Content-Type: application/json' --header 'X-Auth-Email: [email protected]' --header 'X-Auth-Key: tsdfjdslkfjlksdfjksdjlkfjds'  1>"CF-DNS-Records-Fetch-on-$(date +'d-MS').json"
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   113    0   113    0     0    196      0 --:--:-- --:--:-- --:--:--   196
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:--  0:00:01 --:--:--     0curl: (6) Could not resolve host: application
curl: (3) URL using bad/illegal format or missing URL
curl: (3) URL using bad/illegal format or missing URL

This works great for me.

curl --request GET
--url api.cloudflare.com/client/v4/zones/XXXXX/dns_records?name=example.com
--header 'Content-Type: application/json'
--header 'X-Auth-Email: [email protected]'
--header 'X-Auth-Key: XXXXXX' \

"CF-DNS-Records-Fetch-on-$(date +'%m%d-%H%M%S').json"

doesn't work on Windows curl even without backslashes, being one-liner

C:\Users\user\Downloads>curl --request GET --url https://api.cloudflare.com/client/v4/zones/y89f78ds7f8ds7f8s7df8/dns_records?name=url.com --header 'Content-Type: application/json' --header 'X-Auth-Email: [email protected]' --header 'X-Auth-Key: tsdfjdslkfjlksdfjksdjlkfjds'  1>"CF-DNS-Records-Fetch-on-$(date +'d-MS').json"
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   113    0   113    0     0    196      0 --:--:-- --:--:-- --:--:--   196
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:--  0:00:01 --:--:--     0curl: (6) Could not resolve host: application
curl: (3) URL using bad/illegal format or missing URL
curl: (3) URL using bad/illegal format or missing URL

Please try this, works on Windows PowerShell on my end.

PowerShell

$date = Get-Date -Format "MMdd-HHmmss"; curl --request GET --url https://api.cloudflare.com/client/v4/zones/YOUR_ZONE_ID/dns_records --header "Content-Type: application/json" --header "X-Auth-Email: [email protected]" --header "X-Auth-Key: XXX" --output "CF-DNS-Records-Fetch-on-$date.json"

For Bash on Linux.

Bash

curl --request GET \
--url https://api.cloudflare.com/client/v4/zones/YOUR_ZONE_ID/dns_records \
--header 'Content-Type: application/json' \
--header 'X-Auth-Email: [email protected]' \
--header 'X-Auth-Key: XXX' \
> "CF-DNS-Records-Fetch-on-"$(date +"%m%d-%H%M%S").json

Note

Please use your ZONE_ID, not ACCOUNT_ID.

$date = Get-Date -Format "MMdd-HHmmss"; curl --request GET --url https://api.cloudflare.com/client/v4/zones/YOUR_ZONE_ID/dns_records --header "Content-Type: application/json" --header "X-Auth-Email: [email protected]" --header "X-Auth-Key: XXX" --output "CF-DNS-Records-Fetch-on-$date.json"

this works in PS Core 7.4.2

and doesn't work in classic PS 5.0, shipped with Windows

Seems like another bit in long list of differences between the two, just to the attention of the folks who will read the thread.

Anyway, thanks a lot @erbanku, I really appreciate your effort in troubleshooting this. Due to your help I received another error and found out I used the wrong token (API token instead of API key), and got a better understand of CF. Bless you!