---
updatedAt: 2026-05-19T20:06:15.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/powershell/llms.txt
---

# Onboarding CNAME record

Get-AppSecOnboardingCNAMERecord

## Synopsis

List hostname CNAME DNS records.

## Syntax

```powershell
Get-AppSecOnboardingCNAMERecord [-OnboardingID] <Int32> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## Description

Returns the DNS records you need to CNAME to Akamai. Once you update your CNAME record with the information in this call's response, your end user traffic starts to flow through Akamai's platform. Note that you can only CNAME to Akamai after an activation on staging or production is complete.

## Parameters

<table>
  <tbody>
    <tr>
      <td class="ps-td"><code>&#8209;AccountSwitchKey</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use <a href="https://techdocs.akamai.com/powershell/docs/get-accountswitchkey">Get-AccountSwitchKey</a>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;EdgeRCFile</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>Your EdgeGrid resource file to authenticate your command. Defaults to <code>~/.edgerc</code>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;OnboardingID</code><br/><span style="color: red; padding-left: 11px; font-size: 13px;"><em>Required</em></span></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">Int</span>
          <span class="ps-param-metadata">Pipeline input: ByValue, ByPropertyName</span>
        </div>
        <div>
          <p>A unique identifier for an onboarding.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;Section</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to <code>default</code>.</p>
        </div>
      </td>
    </tr>
  </tbody>
</table>

## Related Links

* [User Guide: Overview](https://techdocs.akamai.com/powershell/docs/overview)
* [API Reference](https://techdocs.akamai.com/application-security/reference/get-onboarding-cname-records)

# Sibling pages

* [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/get-appsecpolicybehavioralddos.md)
* [Activation history](https://techdocs.akamai.com/powershell/docs/get-appsecactivationhistory.md)
* [Activation request status](https://techdocs.akamai.com/powershell/docs/get-appsecactivationrequeststatus.md)
* [Activation status](https://techdocs.akamai.com/powershell/docs/get-appsecactivationstatus.md)
* [Attack payload](https://techdocs.akamai.com/powershell/docs/get-appsecattackpayload-1.md)
* [Available hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecavailablehostnames.md)
* [Behavioral DDoS](https://techdocs.akamai.com/powershell/docs/get-appsecbehavioralddos-1.md)
* [Configuration](https://techdocs.akamai.com/powershell/docs/get-appsecconfiguration.md)
* [Configuration attack payload logging](https://techdocs.akamai.com/powershell/docs/get-appsecattackpayloadsettings.md)
* [Configuration bypass network lists](https://techdocs.akamai.com/powershell/docs/get-appsecbypassnetworklists.md)
* [Configuration evaluation hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecevaluationhostnames.md)
* [Configuration evasive path match](https://techdocs.akamai.com/powershell/docs/get-appsecevasivepathmatch.md)
* [Configuration version](https://techdocs.akamai.com/powershell/docs/get-appsecconfigurationversion.md)
* [Configuration version notes](https://techdocs.akamai.com/powershell/docs/get-appsecversionnotes.md)
* [Configuration HTTP header logs](https://techdocs.akamai.com/powershell/docs/get-appseclogging.md)
* [Configuration Pragma settings](https://techdocs.akamai.com/powershell/docs/get-appsecpragmasettings.md)
* [Configuration request body settings](https://techdocs.akamai.com/powershell/docs/get-appsecrequestsizelimit.md)
* [Configuration selected hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecselectedhostnames.md)
* [Contracts & groups](https://techdocs.akamai.com/powershell/docs/get-appseccontractsandgroups.md)
* [Cookie settings](https://techdocs.akamai.com/powershell/docs/get-appseccookiesettings-1.md)
* [Custom deny action](https://techdocs.akamai.com/powershell/docs/get-appseccustomdenyaction.md)
* [Custom rule](https://techdocs.akamai.com/powershell/docs/get-appseccustomrule.md)
* [Custom rule actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycustomrules.md)
* [Custom rule usage](https://techdocs.akamai.com/powershell/docs/get-appseccustomruleusage-1.md)
* [CVE](https://techdocs.akamai.com/powershell/docs/get-appseccve-1.md)
* [CVE coverage](https://techdocs.akamai.com/powershell/docs/get-appseccvecoverage-1.md)
* [CVE subscription](https://techdocs.akamai.com/powershell/docs/get-appseccvesubscription-1.md)
* [Discovered API](https://techdocs.akamai.com/powershell/docs/get-appsecdiscoveredapi.md)
* [Discovered API endpoints](https://techdocs.akamai.com/powershell/docs/get-appsecdiscoveredapiendpoints.md)
* [Export](https://techdocs.akamai.com/powershell/docs/get-appsecexport-1.md)
* [Export status](https://techdocs.akamai.com/powershell/docs/get-appsecexportstatus-1.md)
* [Failover hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecfailoverhostnames.md)
* [Hostname coverage](https://techdocs.akamai.com/powershell/docs/get-appsechostnamecoverage.md)
* [Hostname coverage match targets](https://techdocs.akamai.com/powershell/docs/get-appsechostnamematchtargets.md)
* [Hostname overlaps](https://techdocs.akamai.com/powershell/docs/get-appsechostnameoverlap.md)
* [Malware policy](https://techdocs.akamai.com/powershell/docs/get-appsecmalwarepolicy.md)
* [Malware policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicymalwarepolicy.md)
* [Malware policy content type](https://techdocs.akamai.com/powershell/docs/get-appsecmalwarepolicycontenttype.md)
* [Match target](https://techdocs.akamai.com/powershell/docs/get-appsecmatchtarget.md)
* [Onboarding](https://techdocs.akamai.com/powershell/docs/get-appseconboarding.md)
* [Onboarding activation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingactivation-1.md)
* [Onboarding certificate validation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingcertificatevalidation-1.md)
* [Onboarding origin validation](https://techdocs.akamai.com/powershell/docs/get-appseconboardingoriginvalidation.md)
* [Onboarding settings](https://techdocs.akamai.com/powershell/docs/get-appseconboardingsettings.md)
* [PII learning](https://techdocs.akamai.com/powershell/docs/get-appsecpiisettings.md)
* [Policy](https://techdocs.akamai.com/powershell/docs/get-appsecpolicy.md)
* [Policy adaptive intelligence](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyadaptiveintelligence.md)
* [Policy API request constraints](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyapirequestconstraints.md)
* [Policy API endpoints](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyapiendpoints.md)
* [Policy attack group action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgroup.md)
* [Policy attack group exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgroupexceptions.md)
* [Policy attack group tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackgrouprecommendations.md)
* [Policy attack payload logging](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyattackpayload.md)
* [Policy bypass network lists](https://techdocs.akamai.com/powershell/docs/get-appsecpolicybypassnetworklists.md)
* [Policy CPC](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycpc.md)
* [Policy custom rule](https://techdocs.akamai.com/powershell/docs/get-appsecpolicycustomrule.md)
* [Policy evaluation attack group action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationattackgroup.md)
* [Policy evaluation attack group exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationattackgroupexceptions.md)
* [Policy evaluation hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationhostnames.md)
* [Policy evaluation penalty box](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationpenaltybox.md)
* [Policy evaluation penalty box condition](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationpenaltyboxcondition.md)
* [Policy evaluation rule action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationrule.md)
* [Policy evaluation rule exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevaluationruleexceptions.md)
* [Policy evasive path match](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyevasivepathmatch.md)
* [Policy IP/Geo Firewall settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyipgeofirewall.md)
* [Policy HTTP header logs](https://techdocs.akamai.com/powershell/docs/get-appsecpolicylogging.md)
* [Policy mode](https://techdocs.akamai.com/powershell/docs/get-appsecpolicymode.md)
* [Policy penalty box](https://techdocs.akamai.com/powershell/docs/get-appsecpolicypenaltybox.md)
* [Policy Pragma settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicypragmasettings.md)
* [Policy protections](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyprotections.md)
* [Policy rapid rule](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrule.md)
* [Policy rapid rule condition](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulecondition.md)
* [Policy rapid rule default action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidruledefaultaction.md)
* [Policy rapid rule lock](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulelock.md)
* [Policy rapid rules status](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrapidrulesstatus.md)
* [Policy request body settings](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrequestsizelimit.md)
* [Policy selected hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyselectedhostnames.md)
* [Policy tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicytuningrecommendations.md)
* [Prefetch requests](https://techdocs.akamai.com/powershell/docs/get-appsecprefetch.md)
* [Rate policy](https://techdocs.akamai.com/powershell/docs/get-appsecratepolicy.md)
* [Rate policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyratepolicy.md)
* [Reputation analysis](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyreputationanalysis.md)
* [Reputation profile](https://techdocs.akamai.com/powershell/docs/get-appsecreputationprofile.md)
* [Reputation profile action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyreputationprofile.md)
* [URL protection policy](https://techdocs.akamai.com/powershell/docs/get-appsecurlprotectionpolicy.md)
* [URL protection policy actions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyurlprotectionpolicy.md)
* [Selectable hostnames](https://techdocs.akamai.com/powershell/docs/get-appsecselectablehostnames.md)
* [SIEM settings](https://techdocs.akamai.com/powershell/docs/get-appsecsiemsettings.md)
* [SIEM versions](https://techdocs.akamai.com/powershell/docs/get-appsecsiemversions.md)
* [Slow POST protection](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyslowpost.md)
* [Subscribers](https://techdocs.akamai.com/powershell/docs/get-appsecsubscribers.md)
* [WAF rule action](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrule.md)
* [WAF rule exceptions](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyruleexceptions.md)
* [WAF rule tuning recommendations](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyrulerecommendations.md)
* [WAF rule upgrade details](https://techdocs.akamai.com/powershell/docs/get-appsecpolicyupgradedetails.md)