PowerShell Invoke-RestMethod / CloudFlare API v4 Code Sample

Posted on December 29, 2015 by

If you’re looking to create your own CloudFlare API v4-based PowerShell module, and would like some syntax examples, here’s a simplified breakdown of my CloudFlareDynDns module on github, which I discuss in “Use PowerShell and CloudFlare API v4 to Dynamically Update CloudFlare DNS to your External IP“.

# Set auth and subdomain information
$token = "1234567893feefc5f0q5000bfo0c38d90bbeb"
$email = "example@example.com"
$domain = "example.com"
$record = "homelab"

# Get external IP
$ipaddr = Invoke-RestMethod http://ipinfo.io/json | Select-Object -ExpandProperty ip

$baseurl = "https://api.cloudflare.com/client/v4/zones"
$zoneurl = "$baseurl/?name=$domain"

# To login use...
$headers = @{
	'X-Auth-Key' = $token
	'X-Auth-Email	' = $email
}

# Get Zone info
$zone = Invoke-RestMethod -Uri $zoneurl -Method Get -Headers $headers
$zoneid = $zone.result.id

$recordurl = "$baseurl/$zoneid/dns_records/?name=$record.$domain"

# Get current DNS record
$dnsrecord = Invoke-RestMethod -Uri $recordurl -Method Get -Headers $headers

# If it exists, update, if not, add
if ($dnsrecord.result.count -gt 0) {

	$recordid = $dnsrecord.result.id	
	$dnsrecord.result | Add-Member "content"  $ipaddr -Force 
	$body = $dnsrecord.result | ConvertTo-Json 
	
	$updateurl = "$baseurl/$zoneid/dns_records/$recordid/" 
	$result = Invoke-RestMethod -Uri $updateurl -Method Put -Headers $headers -Body $body
	
	Write-Output "Record $record.$domain has been updated to the IP $($result.result.content)"
	
} else {
	$newrecord = @{
		"type" = "A"
		"name" =  "$record.$domain"
		"content" = $ipaddr
	}
	
	$body = $newrecord | ConvertTo-Json
	$newrecordurl = "$baseurl/$zoneid/dns_records"
	$request = Invoke-RestMethod -Uri $newrecordurl -Method Post -Headers $headers -Body $body -ContentType "application/json"
	Write-Output "New record $record.$domain has been created with the ID $($request.result.id)"
}

# Set auth and subdomain information

$token = "1234567893feefc5f0q5000bfo0c38d90bbeb"

$email = "[email protected]"

$domain = "example.com"

$record = "homelab"

# Get external IP

$ipaddr = Invoke-RestMethod http://ipinfo.io/json | Select-Object -ExpandProperty ip

$baseurl = "https://api.cloudflare.com/client/v4/zones"

$zoneurl = "$baseurl/?name=$domain"

# To login use...

$headers = @{

'X-Auth-Key' = $token

'X-Auth-Email ' = $email

}

# Get Zone info

$zone = Invoke-RestMethod -Uri $zoneurl -Method Get -Headers $headers

$zoneid = $zone.result.id

$recordurl = "$baseurl/$zoneid/dns_records/?name=$record.$domain"

# Get current DNS record

$dnsrecord = Invoke-RestMethod -Uri $recordurl -Method Get -Headers $headers

# If it exists, update, if not, add

if ($dnsrecord.result.count -gt 0) {

$recordid = $dnsrecord.result.id

$dnsrecord.result | Add-Member "content" $ipaddr -Force

$body = $dnsrecord.result | ConvertTo-Json

$updateurl = "$baseurl/$zoneid/dns_records/$recordid/"

$result = Invoke-RestMethod -Uri $updateurl -Method Put -Headers $headers -Body $body

Write-Output "Record $record.$domain has been updated to the IP $($result.result.content)"

} else {

$newrecord = @{

"type" = "A"

"name" = "$record.$domain"

"content" = $ipaddr

}

$body = $newrecord | ConvertTo-Json

$newrecordurl = "$baseurl/$zoneid/dns_records"

$request = Invoke-RestMethod -Uri $newrecordurl -Method Post -Headers $headers -Body $body -ContentType "application/json"

Write-Output "New record $record.$domain has been created with the ID $($request.result.id)"

}

About Chrissy LeMaire

Chrissy is a PowerShell MVP who has worked in IT for nearly 20 years, and currently serves as a Sr. Database Engineer in Belgium. Always an avid scripter, she attended the Monad session at Microsoft’s Professional Developers Conference in Los Angeles back in 2005 and has worked and played with PowerShell ever since. Chrissy is currently pursuing an MS in Systems Engineering at Regis University and helps maintain RealCajunRecipes.com in her spare time. She holds a number of certifications, including those relating to SQL Server, SuSE Linux, SharePoint and network security. She recently became co-lead of the SQL PASS PowerShell Virtual Chapter. You can follow her on Twitter at @cl.

Posted in Networking, PowerShell

3 comments on “PowerShell Invoke-RestMethod / CloudFlare API v4 Code Sample”

Raimund says:

February 3, 2016 at 5:17 pm

This is an awesome script thanks. what would the syntax be to update an @ or catch all record without a prefix like http://www.?

Reply
Chris Davis says:

September 21, 2016 at 5:23 pm

I love your script and it woks well, but how would I use it to update “domain.com” instead of “home.domain.com”?

Reply
- Chris Davis says:
  
  September 21, 2016 at 7:37 pm
  
  I figured it out. If you add replace the “$recordurl = ” line with this code:
  
  if ($record) {
  $recordurl = “$baseurl/$zoneid/dns_records/?name=$record.$domain”
  } else {
  $recordurl = “$baseurl/$zoneid/dns_records/?name=$domain&type=A”
  }
  
  When $record = “”, it works great.
  
  Reply