XM Cloud & Vercel - Script Multiple DNS entries

Jared Arnofsky,•XM CloudVercelPowerShell
Back

Summary

Recently, in XM Cloud we went live with hundreds of sites. We needed a way to create DNS entries for those sites in Vercel without having to manually enter them and risk human error or mistake. Additionally, we needed to add 301 redirects for the www. subdomain for each url.

The Solution

After going through the Vercel Rest Api (opens in a new tab) we realized we could script this fairly easy.

To leverage Vercel's API you need to set up an access token (opens in a new tab).

You also need to identify your project id and team id in the Vercel portal, or in the .vercel folder in your headless app after your initial deploy.

We leveraged the following api call: /v10/projects

DNS Entries - Vercel Script

This Powershell script will make a DNS entry in Vercel as well as a www. 301 redirect for each domain in the array. My script has only two urls in the array, but many more can be added in the same fashion.

function AddNewDomain {
    param 
    (
        $DomainName
    )

    $uri = $vercelBaseApiUrl + "/v10/projects/"+ $projectId + "/domains?teamId=" + $teamId

    $headers = @{Authorization = "Bearer $token"}

    $body = @{name = "$DomainName"}

    $response = Invoke-WebRequest -Method Post -Uri $uri -Headers $headers -Body ($body | ConvertTo-Json) -ContentType "application/json" -UseBasicParsing

    if($response.StatusCode -eq 200)
    {
        $result = ConvertFrom-Json $response.content

        $domainNameAdded = $result.name

        Write-Host "Domain Added" $domainNameAdded
    }
}

function AddNewSubDomainRedirect {
    param 
    (
        $DomainName
    )

    $DomainWithSubDomain = "www." + $DomainName

    $uri = $vercelBaseApiUrl + "/v10/projects/"+ $projectId + "/domains?teamId=" + $teamId

    $headers = @{Authorization = "Bearer $token"}

    $body = @{name = "$DomainWithSubDomain";redirect = "$DomainName";redirectStatusCode = 301}

    $response = Invoke-WebRequest -Method Post -Uri $uri -Headers $headers -Body ($body | ConvertTo-Json) -ContentType "application/json" -UseBasicParsing

    if($response.StatusCode -eq 200)
    {
        $result = ConvertFrom-Json $response.content

        $domainNameAdded = $result.name

        Write-Host "Domain Added" $domainNameAdded
    }
}

Try
{
    # Constants
    $vercelBaseApiUrl = "https://api.vercel.com"
    $token = "[Vercel Token]"
    $teamId = "[Vercel Team ID]"
    $projectId = "[Vercel Project ID]"

    [string[]]$domains = 
            "domain-1.com",
			"domain-2.com"
			#add more domains to the array as needed

    foreach ($domain in $domains) 
    {
        Write-Host "Domain Name: "$domain

        AddNewDomain -DomainName $domain
        AddNewSubDomainRedirect -DomainName $domain

    }
}
Catch
{
    Write-Host "An error occurred: " + $_
}

Conclusion

XM Cloud paired with Vercel made for a very smooth Production release.

Scripting with the Vercel Rest API made it easy to add hundreds of domains and redirects with a single command. Leveraging the Vercel Rest API for tasks like this allows us to save time, reduce human error and create repeatable steps for future XM Cloud projects.