You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:04:58 UTC
[08/75] [partial] incubator-trafficcontrol-website git commit: add
1.8.0 docs
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ee296175/docs/1.8.0/development/traffic_ops_api/v12/cdn.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/development/traffic_ops_api/v12/cdn.html b/docs/1.8.0/development/traffic_ops_api/v12/cdn.html
new file mode 100644
index 0000000..409368a
--- /dev/null
+++ b/docs/1.8.0/development/traffic_ops_api/v12/cdn.html
@@ -0,0 +1,2404 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>CDN — Traffic Control 1.8.0 documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
+ <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
+ <link rel="next" title="Change Logs" href="changelog.html"/>
+ <link rel="prev" title="Cache Statistics" href="cache_stats.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../../_static/tc_logo.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>CDN</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/cdn.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache_stats.html" class="btn btn-neutral" title="Cache Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cdn">
+<span id="to-api-v12-cdn"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">�</a></h1>
+<div class="section" id="api-1-2-cdns">
+<span id="to-api-v12-cdn-route"></span><h2>/api/1.2/cdns<a class="headerlink" href="#api-1-2-cdns" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cdns</strong></p>
+<blockquote>
+<div><p>Allows user to create a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>int</td>
+<td>Whether dnssec is enabled.
+- 0: disabled
+- 1: enabled</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test"</span><span class="p">,</span>
+ <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the creation, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "name": "cdn_test",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was created."
+ }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/cdns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>int</td>
+<td>Whether dnssec is enabled.
+- 0: disabled
+- 1: enabled</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test2"</span><span class="p">,</span>
+ <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "name": "cdn_test2",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cdns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"cdn was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="health">
+<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
+<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across all CDNs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across all CDNs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/usage/overview</strong></p>
+<blockquote>
+<div><p>Retrieves the high-level CDN usage metrics.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">currentGbps</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxGbps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/capacity</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">availablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">unavailablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">utilizedPercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maintenancePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="routing">
+<span id="to-api-v12-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/routing</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="12%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">staticRoute</span></code></td>
+<td>number</td>
+<td>Used pre-configured DNS entries.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">miss</span></code></td>
+<td>number</td>
+<td>No location available for client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geo</span></code></td>
+<td>number</td>
+<td>Used 3rd party geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">err</span></code></td>
+<td>number</td>
+<td>Error localizing client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cz</span></code></td>
+<td>number</td>
+<td>Used Coverage Zone geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsr</span></code></td>
+<td>number</td>
+<td>Overflow traffic sent to secondary CDN.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="metrics">
+<span id="to-api-v12-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
+<blockquote>
+<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">metric_type</span></code></td>
+<td>yes</td>
+<td>ooff, origin_tps</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">start</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">end</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="19%" />
+<col width="31%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>count</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>98thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>min</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>max</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>5thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>95thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>mean</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>sum</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">data</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>time</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>value</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">label</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="p">},</span>
+ <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="mi">1425135900000</span><span class="p">,</span>
+ <span class="mf">1668.03</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="mi">1425136200000</span><span class="p">,</span>
+ <span class="n">null</span>
+ <span class="p">]</span>
+ <span class="p">],</span>
+ <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="domains">
+<span id="to-api-v12-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/domains</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parameterId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="topology">
+<span id="to-api-v12-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/:cdn_name/configs</strong></p>
+<blockquote>
+<div><p>Retrieves CDN config information.</p>
+<p>Authentication Required: Yes</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="21%" />
+<col width="49%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn_name</span></code></td>
+<td>yes</td>
+<td>Your cdn name or, all</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="10%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/configs/monitoring</strong></p>
+<blockquote>
+<div><p>Retrieves CDN monitoring information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="64%" />
+<col width="10%" />
+<col width="26%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of
+cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>hack.ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tm.healthParams.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.dataServer.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>health.timepad</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>health.threadPool</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>health.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>health.event-count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.crConfig.polling.url</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>CDN_name</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of
+delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>totalTpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>totalKbpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profiles</span></code></td>
+<td>array</td>
+<td>A collection of
+profiles.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>parameters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>health.connection.timeout</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>health.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>health.threshold.queryTime</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>history.count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>health.threshold.availableBandwidthInKbps</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>health.threshold.loadavg</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/configs/routing</strong></p>
+<blockquote>
+<div><p>Retrieves CDN routing information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="46%" />
+<col width="11%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>deliveryServices</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>remaps</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>trafficOpsPath</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>cdnName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>trafficOpsVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>trafficOpsUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>date</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>trafficOpsHost</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tld.soa.admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tcoveragezone.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>geolocation.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tld.soa.expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>coveragezone.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tld.soa.minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>geolocation.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>domain_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tld.ttls.AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tld.soa.refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tld.ttls.NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tld.ttls.SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>geolocation6.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tld.ttls.A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tld.soa.retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>geolocation6.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of delivery
+services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>geoEnabled</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>coverageZoneOnly</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>matchSets</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>protocol</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>matchList</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>>regex</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>>matchType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>bypassDestination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>maxDnsIpsForLocation</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>ttls</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>missCoordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>soa</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trafficRouters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>profile</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>apiPort</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="dnssec-keys">
+<span id="to-api-v12-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys</strong></p>
+<blockquote>
+<div><p>Gets a list of dnsseckeys for a CDN and all associated Delivery Services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="8%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span> <span class="pre">name/ds</span> <span class="pre">xml_id</span></code></td>
+<td>string</td>
+<td>identifier for ds or cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>zsk/ksk</span></code></td>
+<td>array</td>
+<td>collection of zsk/ksk data</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>ttl</span></code></td>
+<td>string</td>
+<td>time-to-live for dnssec requests</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>inceptionDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp for when the keys were created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>expirationDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp representing the expiration of the keys</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>private</span></code></td>
+<td>string</td>
+<td>encoded private key</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>public</span></code></td>
+<td>string</td>
+<td>encoded public key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>name</span></code></td>
+<td>string</td>
+<td>domain name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ksk>>dsRecord>>algorithm</span></code></td>
+<td>string</td>
+<td>The algorithm of the referenced DNSKEY-recor.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ksk>>dsRecord>>digestType</span></code></td>
+<td>string</td>
+<td>Cryptographic hash algorithm used to create the Digest value.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ksk>>dsRecord>>digest</span></code></td>
+<td>string</td>
+<td>A cryptographic hash value of the referenced DNSKEY-record.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60",
+ dsRecord: {
+ "algorithm": "5",
+ "digestType": "2",
+ "digest": "abc123def456"
+ }
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys/delete</strong></p>
+<blockquote>
+<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="13%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>name of the CDN for which you want to delete dnssec keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>success response</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted dnssec keys for <cdn>"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/dnsseckeys/generate</strong></p>
+<blockquote>
+<div><p>Generates ZSK and KSK keypairs for a CDN and all associated Delivery Services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="11%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>name of the cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>domain name of the cdn</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td>time to live</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">kskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the key signing keys</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the zone signing keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+}
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created dnssec keys for cdn1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="ssl-keys">
+<span id="to-api-v12-cdn-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/cdns/name/:name/sslkeys</strong></p>
+<blockquote>
+<div><p>Returns ssl certificates for all Delivery Services that are a part of the CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="8%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>identifier for deliveryservice xml_id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">certificate</span></code></td>
+<td>array</td>
+<td>collection of certificate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>key</span></code></td>
+<td>string</td>
+<td>base64 encoded private key for ssl certificate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>crt</span></code></td>
+<td>string</td>
+<td>base64 encoded ssl certificate</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds1"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt1"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey1"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds2"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt2"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey2"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache_stats.html" class="btn btn-neutral" title="Cache Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../',
+ VERSION:'1.8.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable
<TRUNCATED>