| |
| |
| |
| |
| <!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>Federation — Traffic Control 2.2-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="index" title="Index" |
| href="../../genindex.html"/> |
| <link rel="search" title="Search" href="../../search.html"/> |
| <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/> |
| <link rel="up" title="API 1.2 Reference" href="index.html"/> |
| <link rel="next" title="Federation Delivery Service" href="federation_deliveryservice.html"/> |
| <link rel="prev" title="Divisions" href="division.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_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/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/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</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> |
| <li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</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 2.2-dev</a> »</li> |
| |
| <li><a href="../index.html">APIs</a> »</li> |
| |
| <li><a href="index.html">API 1.2 Reference</a> »</li> |
| |
| <li>Federation</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../_sources/api/v12/federation.rst.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="federation"> |
| <span id="to-api-v12-federation"></span><h1>Federation<a class="headerlink" href="#federation" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="api-1-2-federations"> |
| <span id="to-api-v12-federation-route"></span><h2>/api/1.2/federations<a class="headerlink" href="#api-1-2-federations" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/federations.json</strong></p> |
| <blockquote> |
| <div><p>Retrieves a list of federation mappings (aka federation resolvers) for a the current user.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Federation</p> |
| <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 notranslate"><span class="pre">cname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>int</td> |
| <td>Time to live for the cname.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td> |
| <td>string</td> |
| <td>Unique string that describes the deliveryservice.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"cname-01."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">8865</span><span class="p">,</span> |
| <span class="p">]</span> |
| <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ds-01"</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>POST /api/1.2/federations.json</strong></p> |
| <blockquote> |
| <div><p>Allows a user to add federations for their delivery service(s).</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Federation</p> |
| <p><strong>Request 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 notranslate"><span class="pre">deliveryService</span></code></td> |
| <td>string</td> |
| <td>Unique string that describes the deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">resolve4</span></code></td> |
| <td>array</td> |
| <td>Array of IPv4 Addresses.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">resolve6</span></code></td> |
| <td>array</td> |
| <td>Array of IPv6 Addresses.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> |
| <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"255.255.255.255"</span> |
| <span class="p">],</span> |
| <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> |
| <span class="p">]</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>DELETE /api/1.2/federations.json</strong></p> |
| <blockquote> |
| <div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s).</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Federation</p> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>PUT /api/1.2/federations.json</strong></p> |
| <blockquote> |
| <div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s) then adds the new federations.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Federation</p> |
| <p><strong>Request 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 notranslate"><span class="pre">deliveryService</span></code></td> |
| <td>string</td> |
| <td>Unique string that describes the deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">resolve4</span></code></td> |
| <td>array</td> |
| <td>Array of IPv4 Addresses.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">resolve6</span></code></td> |
| <td>array</td> |
| <td>Array of IPv6 Addresses.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> |
| <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"255.255.255.255"</span> |
| <span class="p">],</span> |
| <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> |
| <span class="p">]</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/federations</strong></p> |
| <blockquote> |
| <div><p>Retrieves a list of federations for a 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="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 notranslate"><span class="pre">cname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>int</td> |
| <td>Time to live for the cname.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>id</span></code></td> |
| <td>int</td> |
| <td>Delivery service ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td> |
| <td>string</td> |
| <td>Delivery service xml id</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span> |
| <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</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/federations/:id</strong></p> |
| <blockquote> |
| <div><p>Retrieves a federation for a 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="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 notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>CDN name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td> |
| <td>string</td> |
| <td>Federation ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <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 notranslate"><span class="pre">cname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>int</td> |
| <td>Time to live for the cname.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>id</span></code></td> |
| <td>int</td> |
| <td>Delivery service ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td> |
| <td>string</td> |
| <td>Delivery service xml id</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span> |
| <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</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> |
| <dl class="docutils"> |
| <dt><strong>POST /api/1.2/cdns/:name/federations</strong></dt> |
| <dd><p class="first">Create a federation</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="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 notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>CDN name.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="38%" /> |
| <col width="17%" /> |
| <col width="45%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</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 notranslate"><span class="pre">cname</span></code></td> |
| <td>yes</td> |
| <td>CNAME ending with a dot</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>yes</td> |
| <td>TTL</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> |
| <td>no</td> |
| <td>Description</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><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 notranslate"><span class="pre">cname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation created [ cname = the.cname. ] with id: 26."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</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> |
| <dl class="docutils"> |
| <dt><strong>PUT /api/1.2/cdns/:name/federations/:id</strong></dt> |
| <dd><p class="first">Update a federation</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="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 notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>CDN name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td> |
| <td>string</td> |
| <td>Federation ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="38%" /> |
| <col width="17%" /> |
| <col width="45%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</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 notranslate"><span class="pre">cname</span></code></td> |
| <td>yes</td> |
| <td>CNAME ending with a dot</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>yes</td> |
| <td>TTL</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> |
| <td>no</td> |
| <td>Description</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><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 notranslate"><span class="pre">cname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation updated [ cname = the.cname. ] with id: 26."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span> |
| <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</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>DELETE /api/1.2/cdns/:name/federations/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allow user to delete a federation.</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="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 notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>CDN name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td> |
| <td>string</td> |
| <td>Federation ID.</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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation deleted [ cname = the.cname. ] with id: 26."</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="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="division.html" class="btn btn-neutral" title="Divisions"><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> |
| |
| |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book">Apache Traffic Control (Incubating)</span> |
| v: |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="/docs/master/">latest</a></dd> |
| <dd><a href="/docs/2.0/">2.0</a></dd> |
| <dd><a href="/docs/1.8.1/">1.8</a></dd> |
| <dd><a href="/docs/1.7.0/">1.7</a></dd> |
| </dl> |
| <hr/> |
| Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. |
| |
| </div> |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../', |
| VERSION:'2.2-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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> |