blob: bce934d5733071ea2785790cebe9d38dc638f1b8 [file] [log] [blame]
<!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>Cache Group &mdash; Traffic Control 2.1-dev 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 2.1-dev documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Cache Group parameters" href="cachegroup_parameter.html"/>
<link rel="prev" title="ASN" href="asn.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_c_only.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&#8217;s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.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&#8217;s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li>
<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_monitor_golang.html">Traffic Monitor Golang</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>
&nbsp;
</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 2.1-dev</a> &raquo;</li>
<li><a href="../../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../../traffic_ops.html">Traffic Ops</a> &raquo;</li>
<li>Cache Group</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="cache-group">
<span id="to-api-v12-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline"></a></h1>
<div class="section" id="api-1-2-cachegroups">
<span id="to-api-v12-cachegroups-route"></span><h2>/api/1.2/cachegroups<a class="headerlink" href="#api-1-2-cachegroups" title="Permalink to this headline"></a></h2>
<p><strong>GET /api/1.1/cachegroups</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Query 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">type</span></code></td>
<td>no</td>
<td>Filter cache groups by Type ID.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="7%" />
<col width="63%" />
</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>Local unique identifier for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time / Date this entry was last updated</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
<td>Parent cachegroup ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
<td>Parent cachegroup name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
<td>Secondary parent cachegroup ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
<td>string</td>
<td>Secondary parent cachegroup name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
<td>Unique identifier for the &#8216;Type&#8217; of Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
<td>string</td>
<td>The name of the type of Cache Group entry</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;21&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-09-25 20:27:28&quot;</span><span class="p">,</span>
<span class="s2">&quot;latitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;longitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;shortName&quot;</span><span class="p">:</span> <span class="s2">&quot;dcchi&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;MID_LOC&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;4&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;22&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-09-25 20:27:28&quot;</span><span class="p">,</span>
<span class="s2">&quot;latitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;longitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;shortName&quot;</span><span class="p">:</span> <span class="s2">&quot;dcchi&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;MID_LOC&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;4&quot;</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/cachegroups/trimmed</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">name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-cmc&quot;</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/cachegroups/:id</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="30%" />
<col width="7%" />
<col width="63%" />
</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>Local unique identifier for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time / Date this entry was last updated</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
<td>Parent cachegroup ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
<td>Parent cachegroup name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
<td>Secondary parent cachegroup ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
<td>string</td>
<td>Secondary parent cachegroup name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
<td>Unique identifier for the &#8216;Type&#8217; of Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
<td>string</td>
<td>The name of the type of Cache Group entry</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;21&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-09-25 20:27:28&quot;</span><span class="p">,</span>
<span class="s2">&quot;latitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;longitude&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupId&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;secondaryParentCachegroupName&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;shortName&quot;</span><span class="p">:</span> <span class="s2">&quot;dcchi&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;MID_LOC&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;4&quot;</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/cachegroups/:id/parameters</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="30%" />
<col width="7%" />
<col width="63%" />
</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>int</td>
<td>Local unique identifier for the parameter</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>Name of the parameter</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
<td>string</td>
<td>Value of the parameter</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">configFile</span></code></td>
<td>string</td>
<td>Config file associated with the parameter</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
<td>bool</td>
<td>Is the parameter value only visible to admin users</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time / Date this entry was last updated</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;1100&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;cgw.originUrl&quot;</span><span class="p">,</span>
<span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;http://to-short.g.foo.net/data/&quot;</span><span class="p">,</span>
<span class="s2">&quot;configFile&quot;</span><span class="p">:</span> <span class="s2">&quot;foo.config&quot;</span><span class="p">,</span>
<span class="s2">&quot;secure&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2015-08-27 15:11:49&quot;</span>
<span class="p">},</span>
<span class="p">{</span> <span class="o">...</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/cachegroups/:id/unassigned_parameters</strong></p>
<blockquote>
<div><p>Retrieves all parameters NOT assigned to the cache group.</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="35%" />
<col width="20%" />
<col width="45%" />
</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>Cache group id</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="8%" />
<col width="75%" />
</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">last_updated</span></code></td>
<td>string</td>
<td>The Time / Date this server entry was last updated</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
<td>boolean</td>
<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
<td>string</td>
<td>The parameter value, only visible to admin if secure is true</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The parameter name</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
<td>string</td>
<td>The parameter config_file</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;last_updated&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-09-17 21:41:22&quot;</span><span class="p">,</span>
<span class="s2">&quot;secure&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;0,1,2,3,4,5,6&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Drive_Letters&quot;</span><span class="p">,</span>
<span class="s2">&quot;config_file&quot;</span><span class="p">:</span> <span class="s2">&quot;storage.config&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;last_updated&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-09-17 21:41:22&quot;</span><span class="p">,</span>
<span class="s2">&quot;secure&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;STRING __HOSTNAME__&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;CONFIG proxy.config.proxy_name&quot;</span><span class="p">,</span>
<span class="s2">&quot;config_file&quot;</span><span class="p">:</span> <span class="s2">&quot;records.config&quot;</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/cachegroup/:parameter_id/parameter</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="44%" />
<col width="24%" />
<col width="32%" />
</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">parameter_id</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="45%" />
<col width="21%" />
<col width="34%" />
</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">cachegroups</span></code></td>
<td>array</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;id</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;cachegroups&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;21&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-cmc&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;22&quot;</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/cachegroupparameters</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="35%" />
<col width="11%" />
<col width="55%" />
</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">cachegroupParameters</span></code></td>
<td>array</td>
<td>A collection of cache group parameters.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;parameter</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;cachegroup</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;cachegroupParameters&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;parameter&quot;</span><span class="p">:</span> <span class="s2">&quot;379&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2013-08-05 18:49:37&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-ca-sanjose&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;parameter&quot;</span><span class="p">:</span> <span class="s2">&quot;380&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2013-08-05 18:49:37&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-ca-sanjose&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;parameter&quot;</span><span class="p">:</span> <span class="s2">&quot;379&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2013-08-05 18:49:37&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-ma-woburn&quot;</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/cachegroups/:parameter_id/parameter/available</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="44%" />
<col width="24%" />
<col width="32%" />
</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">parameter_id</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<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">name</span></code></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;21&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;dc-cmc&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;22&quot;</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>POST /api/1.2/cachegroups</strong></p>
<blockquote>
<div><p>Create cache group.</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="30%" />
<col width="9%" />
<col width="61%" />
</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>The name of the Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>yes</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>no</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>no</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td>
<td>no</td>
<td>Name of Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td>
<td>no</td>
<td>Name of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>yes</td>
<td>The type of Cache Group entry, &#8220;EDGE_LOC&#8221;, &#8220;MID_LOC&#8221; or &#8220;ORG_LOC&#8221;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;cache_group_edge&quot;</span><span class="p">,</span>
<span class="s2">&quot;shortName&quot;</span><span class="p">:</span> <span class="s2">&quot;cg_edge&quot;</span><span class="p">,</span>
<span class="s2">&quot;latitude&quot;</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
<span class="s2">&quot;longitude&quot;</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;cache_group_mid&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="mi">6</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="7%" />
<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>The id of cache group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td>
<td>string</td>
<td>Name of Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
<td>id of Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td>
<td>string</td>
<td>Name of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
<td>id of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
<td>string</td>
<td>The type of Cache Group entry, &#8220;EDGE_LOC&#8221;, &#8220;MID_LOC&#8221; or &#8220;ORG_LOC&#8221;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time / Date this entry was last updated</td>
</tr>
<tr class="row-odd"><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-even"><td><code class="docutils literal"><span class="pre">&gt;level</span></code></td>
<td>string</td>
<td>Success, info, warning or error.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;text</span></code></td>
<td>string</td>
<td>Alert message.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;alerts&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;level&quot;</span><span class="p">:</span> <span class="s2">&quot;success&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s2">&quot;Cachegroup successfully created: cache_group_edge&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;longitude&#39;</span> <span class="p">:</span> <span class="s1">&#39;45&#39;</span><span class="p">,</span>
<span class="s1">&#39;lastUpdated&#39;</span> <span class="p">:</span> <span class="s1">&#39;2016-01-25 13:55:30&#39;</span><span class="p">,</span>
<span class="s1">&#39;shortName&#39;</span> <span class="p">:</span> <span class="s1">&#39;cg_edge&#39;</span><span class="p">,</span>
<span class="s1">&#39;name&#39;</span> <span class="p">:</span> <span class="s1">&#39;cache_group_edge&#39;</span><span class="p">,</span>
<span class="s1">&#39;parentCachegroup&#39;</span> <span class="p">:</span> <span class="s1">&#39;cache_group_mid&#39;</span><span class="p">,</span>
<span class="s1">&#39;secondaryParentCachegroup&#39;</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s1">&#39;latitude&#39;</span> <span class="p">:</span> <span class="s1">&#39;12&#39;</span><span class="p">,</span>
<span class="s1">&#39;typeName&#39;</span> <span class="p">:</span> <span class="s1">&#39;EDGE_LOC&#39;</span><span class="p">,</span>
<span class="s1">&#39;id&#39;</span> <span class="p">:</span> <span class="s1">&#39;104&#39;</span><span class="p">,</span>
<span class="s1">&#39;parentCachegroupId&#39;</span> <span class="p">:</span> <span class="s1">&#39;103&#39;</span><span class="p">,</span>
<span class="s1">&#39;secondaryParentCachegroupId&#39;</span> <span class="p">:</span> <span class="n">null</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>PUT /api/1.2/cachegroups/{:id}</strong></p>
<blockquote>
<div><p>Update cache group.</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="12%" />
<col width="19%" />
<col width="69%" />
</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>id</td>
<td>yes</td>
<td>The id of the cache group to edit.</td>
</tr>
</tbody>
</table>
<p><strong>Request Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="9%" />
<col width="61%" />
</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>The name of the Cache Group entry</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>yes</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>no</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>no</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td>
<td>no</td>
<td>Name of Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td>
<td>no</td>
<td>Name of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
<td>yes</td>
<td>The type of Cache Group entry, &#8220;EDGE_LOC&#8221;, &#8220;MID_LOC&#8221; or &#8220;ORG_LOC&#8221;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;cache_group_edge&quot;</span><span class="p">,</span>
<span class="s2">&quot;shortName&quot;</span><span class="p">:</span> <span class="s2">&quot;cg_edge&quot;</span><span class="p">,</span>
<span class="s2">&quot;latitude&quot;</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
<span class="s2">&quot;longitude&quot;</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
<span class="s2">&quot;parentCachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;cache_group_mid&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE_LOC&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="7%" />
<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>The id of cache group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
<td>Latitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td>
<td>string</td>
<td>Name of Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
<td>id of Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td>
<td>string</td>
<td>Name of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
<td>id of Secondary Parent Cache Group entry.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
<td>string</td>
<td>The type of Cache Group entry, &#8220;EDGE_LOC&#8221;, &#8220;MID_LOC&#8221; or &#8220;ORG_LOC&#8221;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time / Date this entry was last updated</td>
</tr>
<tr class="row-odd"><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-even"><td><code class="docutils literal"><span class="pre">&gt;level</span></code></td>
<td>string</td>
<td>Success, info, warning or error.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;text</span></code></td>
<td>string</td>
<td>Alert message.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;alerts&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;level&quot;</span><span class="p">:</span> <span class="s2">&quot;success&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s2">&quot;Cachegroup was updated: cache_group_edge&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;longitude&#39;</span> <span class="p">:</span> <span class="s1">&#39;45&#39;</span><span class="p">,</span>
<span class="s1">&#39;lastUpdated&#39;</span> <span class="p">:</span> <span class="s1">&#39;2016-01-25 13:55:30&#39;</span><span class="p">,</span>
<span class="s1">&#39;shortName&#39;</span> <span class="p">:</span> <span class="s1">&#39;cg_edge&#39;</span><span class="p">,</span>
<span class="s1">&#39;name&#39;</span> <span class="p">:</span> <span class="s1">&#39;cache_group_edge&#39;</span><span class="p">,</span>
<span class="s1">&#39;parentCachegroup&#39;</span> <span class="p">:</span> <span class="s1">&#39;cache_group_mid&#39;</span><span class="p">,</span>
<span class="s1">&#39;secondaryParentCachegroup&#39;</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s1">&#39;latitude&#39;</span> <span class="p">:</span> <span class="s1">&#39;12&#39;</span><span class="p">,</span>
<span class="s1">&#39;typeName&#39;</span> <span class="p">:</span> <span class="s1">&#39;EDGE_LOC&#39;</span><span class="p">,</span>
<span class="s1">&#39;id&#39;</span> <span class="p">:</span> <span class="s1">&#39;104&#39;</span><span class="p">,</span>
<span class="s1">&#39;parentCachegroupId&#39;</span> <span class="p">:</span> <span class="s1">&#39;103&#39;</span><span class="p">,</span>
<span class="s1">&#39;secondaryParentCachegroupId&#39;</span> <span class="p">:</span> <span class="n">null</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>DELETE /api/1.2/cachegroups/{:id}</strong></p>
<blockquote>
<div><p>Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.</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="11%" />
<col width="19%" />
<col width="70%" />
</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>id</td>
<td>yes</td>
<td>The id of the cache group to delete.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="15%" />
<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">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">&gt;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">&gt;text</span></code></td>
<td>string</td>
<td>Alert message.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;alerts&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;level&quot;</span><span class="p">:</span> <span class="s2">&quot;success&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s2">&quot;Cachegroup was deleted: cache_group_edge&quot;</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>POST /api/1.2/cachegroups/{:id}/queue_update</strong></p>
<blockquote>
<div><p>Queue or dequeue updates for all servers assigned to a cache group limited to a specific 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="35%" />
<col width="20%" />
<col width="45%" />
</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>id</td>
<td>yes</td>
<td>the cachegroup id.</td>
</tr>
</tbody>
</table>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="67%" />
</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>action</td>
<td>string</td>
<td>queue or dequeue</td>
</tr>
<tr class="row-odd"><td>cdn</td>
<td>string</td>
<td>cdn name or cdn ID is required</td>
</tr>
<tr class="row-even"><td>cdnId</td>
<td>string</td>
<td>cdn ID or cdn name is required</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="12%" />
<col width="67%" />
</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>action</td>
<td>string</td>
<td>The action processed, queue or dequeue.</td>
</tr>
<tr class="row-odd"><td>cachegroupId</td>
<td>integer</td>
<td>cachegroup id</td>
</tr>
<tr class="row-even"><td>cachegroupName</td>
<td>string</td>
<td>cachegroup name</td>
</tr>
<tr class="row-odd"><td>cdn</td>
<td>string</td>
<td>cdn name</td>
</tr>
<tr class="row-even"><td>serverNames</td>
<td>array</td>
<td>servers name array in the cachegroup in cdn</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;cachegroupName&quot;</span><span class="p">:</span> <span class="s2">&quot;us-il-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;action&quot;</span><span class="p">:</span> <span class="s2">&quot;queue&quot;</span><span class="p">,</span>
<span class="s2">&quot;serverNames&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">&quot;atsec-chi-00&quot;</span><span class="p">,</span>
<span class="s2">&quot;atsec-chi-01&quot;</span><span class="p">,</span>
<span class="s2">&quot;atsec-chi-02&quot;</span><span class="p">,</span>
<span class="s2">&quot;atsec-chi-03&quot;</span><span class="p">,</span>
<span class="p">],</span>
<span class="s2">&quot;cachegroupId&quot;</span><span class="p">:</span> <span class="s2">&quot;93&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdn&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn_number_1&quot;</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>POST /api/1.2/cachegroups/{:id}/deliveryservices</strong></p>
<blockquote>
<div><p>Assign deliveryservices for servers in cachegroup</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="17%" />
<col width="9%" />
<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>id</td>
<td>yes</td>
<td>The cachegroup id.</td>
</tr>
</tbody>
</table>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="9%" />
<col width="74%" />
</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>deliveryServices</td>
<td>array</td>
<td>The Ids of the delivery services to assign to each server in the cachegroup.</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;deliveryServices&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="12%" />
<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>response</td>
<td>hash</td>
<td>The details of the assignment, if success.</td>
</tr>
<tr class="row-odd"><td>&gt;id</td>
<td>int</td>
<td>The cachegroup id.</td>
</tr>
<tr class="row-even"><td>&gt;serverNames</td>
<td>array</td>
<td>The server name array in the cachegroup.</td>
</tr>
<tr class="row-odd"><td>&gt;deliveryServices</td>
<td>array</td>
<td>The deliveryservice id array.</td>
</tr>
<tr class="row-even"><td>alerts</td>
<td>array</td>
<td>A collection of alert messages.</td>
</tr>
<tr class="row-odd"><td>&gt;level</td>
<td>string</td>
<td>Success, info, warning or error.</td>
</tr>
<tr class="row-even"><td>&gt;text</td>
<td>string</td>
<td>Alert message.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
<span class="s2">&quot;serverNames&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="s2">&quot;atlanta-edge-01&quot;</span><span class="p">,</span> <span class="s2">&quot;atlanta-edge-07&quot;</span> <span class="p">],</span>
<span class="s2">&quot;deliveryServices&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
<span class="s2">&quot;alerts&quot;</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;level&quot;</span><span class="p">:</span> <span class="s2">&quot;success&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s2">&quot;Delivery services successfully assigned to all the servers of cache group 3.&quot;</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="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="asn.html" class="btn btn-neutral" title="ASN"><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:'2.1-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</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();
});
</script>
</body>
</html>