| |
| |
| <!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>Profiles — 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="Profile parameters" href="profile_parameter.html"/> |
| <link rel="prev" title="Physical Location" href="phys_location.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’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’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> |
| |
| </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> »</li> |
| |
| <li><a href="../../index.html">Developer’s Guide</a> »</li> |
| |
| <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> |
| |
| <li>Profiles</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../../_sources/development/traffic_ops_api/v12/profile.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="profiles"> |
| <span id="to-api-v12-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="api-1-2-profiles"> |
| <span id="to-api-v12-profiles-route"></span><h2>/api/1.2/profiles<a class="headerlink" href="#api-1-2-profiles" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/profiles</strong></p> |
| <blockquote> |
| <div><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="19%" /> |
| <col width="13%" /> |
| <col width="68%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">param</span></code></td> |
| <td>no</td> |
| <td>Used to filter profiles by parameter ID.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>no</td> |
| <td>Used to filter profiles by CDN ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="10%" /> |
| <col width="68%" /> |
| </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>Primary key</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name for the profile</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>The description for the profile</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>int</td> |
| <td>The CDN ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>The CDN name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>Profile type</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>array</td> |
| <td>The Time / Date this server entry was last updated</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><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="s2">"8"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</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/profiles/trimmed</strong></p> |
| <blockquote> |
| <div><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="22%" /> |
| <col width="10%" /> |
| <col width="68%" /> |
| </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>The name for the profile</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><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">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</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/profiles/:id</strong></p> |
| <blockquote> |
| <div><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="22%" /> |
| <col width="16%" /> |
| <col width="62%" /> |
| </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"><span class="pre">id</span></code></td> |
| <td>yes</td> |
| <td>The ID of the profile.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="10%" /> |
| <col width="68%" /> |
| </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>Primary key</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name for the profile</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>The description for the profile</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>int</td> |
| <td>The CDN ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>The CDN name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>Profile type</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>array</td> |
| <td>The Time / Date this server entry was last updated</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><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="s2">"8"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</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/profiles</strong></dt> |
| <dd><blockquote class="first"> |
| <div><p>Create a new empty profile.</p> |
| <blockquote> |
| <div><p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <col width="12%" /> |
| <col width="50%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</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>string</td> |
| <td>yes</td> |
| <td>Profile name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Profile description</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>int</td> |
| <td>no</td> |
| <td>CDN ID</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Profile type</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| </div></blockquote> |
| <p><strong>Request Example</strong></p> |
| <div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <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>Profile ID</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>Profile name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>Profile description</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>int</td> |
| <td>CDN ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>Profile type</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><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="s2">"66"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</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/profiles/name/:profile_name/copy/:profile_copy_from</strong></dt> |
| <dd><blockquote class="first"> |
| <div><p>Copy profile to a new profile. The new profile name must not exist.</p> |
| <blockquote> |
| <div><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="36%" /> |
| <col width="16%" /> |
| <col width="48%" /> |
| </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">profile_name</span></code></td> |
| <td>yes</td> |
| <td>The name of profile to copy</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile_copy_from</span></code></td> |
| <td>yes</td> |
| <td>The name of profile copy from</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <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>Id of the new profile</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 new profile</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profileCopyFrom</span></code></td> |
| <td>string</td> |
| <td>The name of profile to copy</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">idCopyFrom</span></code></td> |
| <td>string</td> |
| <td>The id of profile to copy</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>new profile’s description (copied)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="last highlight-default"><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="s2">"66"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span> |
| <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span> |
| <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>PUT /api/1.2/profiles/{:id}</strong></p> |
| <blockquote> |
| <div><blockquote> |
| <div><p>Allows user to edit a profile.</p> |
| <blockquote> |
| <div><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="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">id</span></code></td> |
| <td>yes</td> |
| <td>profile id.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <col width="12%" /> |
| <col width="50%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</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>string</td> |
| <td>yes</td> |
| <td>Profile name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Profile description</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>int</td> |
| <td>no</td> |
| <td>CDN ID - must use the same ID as any |
| servers assigned to the profile.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Profile type</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| </div></blockquote> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>{ |
| "name": "EDGE_28_PROFILE", |
| "description": "EDGE_28_PROFILE description", |
| "cdn": 1, |
| "type": "ATS_PROFILE" |
| } |
| |
| **Response Properties** |
| |
| +-----------------------+--------+----------------------------------------------------+ |
| | Parameter | Type | Description | |
| +=======================+========+====================================================+ |
| | ``id`` | string | Profile ID | |
| +-----------------------+--------+----------------------------------------------------+ |
| | ``name`` | string | Profile name | |
| +-----------------------+--------+----------------------------------------------------+ |
| | ``description`` | string | Profile description | |
| +-----------------------+--------+----------------------------------------------------+ |
| | ``cdn`` | int | CDN ID | |
| +-----------------------+--------+----------------------------------------------------+ |
| | ``type`` | string | Profile type | |
| +-----------------------+--------+----------------------------------------------------+ |
| </pre></div> |
| </div> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> |
| <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> |
| <span class="p">}</span> |
| <span class="s2">"alerts"</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">"Profile was updated: 219"</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/profiles/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allows user to delete a profile.</p> |
| <blockquote> |
| <div><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="31%" /> |
| <col width="18%" /> |
| <col width="51%" /> |
| </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>profile 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"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td>success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><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">"Profile was deleted."</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><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> |