| |
| |
| <!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>Users — 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="Snapshot CRConfig" href="topology.html"/> |
| <link rel="prev" title="Types" href="type.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>Users</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../../_sources/development/traffic_ops_api/v12/user.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="topology.html" class="btn btn-neutral float-right" title="Snapshot CRConfig">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="users"> |
| <span id="to-api-v12-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="api-1-2-users"> |
| <span id="to-api-v12-users-route"></span><h2>/api/1.2/users<a class="headerlink" href="#api-1-2-users" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/users</strong></p> |
| <blockquote> |
| <div><p>Retrieves all users.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> |
| <td>string</td> |
| <td>Owning tenant name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td> </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">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span> |
| <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span> |
| <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span> |
| <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span> |
| <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="o">...</span> <span class="n">more</span> <span class="n">users</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/users/:id</strong></p> |
| <blockquote> |
| <div><p>Retrieves user by ID.</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="17%" /> |
| <col width="15%" /> |
| <col width="68%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>yes</td> |
| <td>User id.</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">addressLine1</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> |
| <td>string</td> |
| <td>Owning tenant name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td> </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">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span> |
| <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span> |
| <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span> |
| <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span> |
| <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="o">...</span> <span class="n">more</span> <span class="n">users</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/users</strong></p> |
| <blockquote> |
| <div><p>Create a user.</p> |
| <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="27%" /> |
| <col width="9%" /> |
| <col width="11%" /> |
| <col width="53%" /> |
| </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">addressLine1</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">confirmLocalPassword</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">localPassword</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>bool</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>int</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>no</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td> </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">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span> |
| <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span> |
| <span class="s2">"role"</span><span class="p">:</span> <span class="mi">6</span> |
| <span class="s2">"localPassword"</span><span class="p">:</span> <span class="s2">"password"</span> |
| <span class="s2">"confirmLocalPassword"</span><span class="p">:</span> <span class="s2">"password"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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"><span class="pre">addressLine1</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td> </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">"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">"User creation was successful."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"response: {</span> |
| <span class="s2">"addressLine1"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"addressLine2"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"company"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"country"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"email"</span><span class="p">:</span><span class="s2">"email1@email.com"</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span><span class="s2">"Tom Simpson"</span><span class="p">,</span> |
| <span class="s2">"gid"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span> |
| <span class="s2">"newUser"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> |
| <span class="s2">"phoneNumber"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"postalCode"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"publicSshKey"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"registrationSent"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> |
| <span class="s2">"role"</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span> |
| <span class="s2">"roleName"</span><span class="p">:</span><span class="s2">"portal"</span><span class="p">,</span> |
| <span class="s2">"stateOrProvince"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"uid"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span><span class="s2">"tsimpson"</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/users/:id/deliveryservices</strong></p> |
| <blockquote> |
| <div><p>Retrieves all delivery services assigned to the user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="13%" /> |
| <col width="65%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>yes</td> |
| <td>User ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="5%" /> |
| <col width="80%" /> |
| </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">active</span></code></td> |
| <td>bool</td> |
| <td>true if active, false if inactive.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> |
| <td>string</td> |
| <td>Cache URL rule to apply to this delivery service.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> |
| <td>string</td> |
| <td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> |
| <td>string</td> |
| <td>Id of the CDN to which the delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>Name of the CDN to which the delivery service belongs to.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td> |
| <td>string</td> |
| <td>The path portion of the URL to check this deliveryservice for health.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> |
| <td>string</td> |
| <td>The display name of the delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> |
| <td>string</td> |
| <td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> |
| <td>string</td> |
| <td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> |
| <td>string</td> |
| <td>The TTL of the DNS bypass response.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> |
| <td>string</td> |
| <td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> |
| <td>string</td> |
| <td>The EDGE header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td> |
| <td>string</td> |
| <td><ul class="first simple"> |
| <li>0: None - no limitations</li> |
| <li>1: Only route on CZF file hit</li> |
| <li>2: Only route on CZF hit or when from USA</li> |
| </ul> |
| <p class="last">Note that this does not prevent access to content or makes content secure; it just prevents |
| routing to the content by Traffic Router.</p> |
| </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> |
| <td>string</td> |
| <td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td> |
| <td>string</td> |
| <td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
| traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| HTTP deliveryservices</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td> |
| <td>string</td> |
| <td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td> |
| <td>string</td> |
| <td>Use this to add a URL that points to more information about that deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td> |
| <td>bool</td> |
| <td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field 1.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> |
| <td>string</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td> |
| <td>string</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> |
| <td>string</td> |
| <td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> |
| <td>string</td> |
| <td>The set Number of the matchList.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> |
| <td>string</td> |
| <td>The regexp for the matchList.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> |
| <td>string</td> |
| <td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| available).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> |
| <td>string</td> |
| <td>The MID header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> |
| <td>string</td> |
| <td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> |
| <td>string</td> |
| <td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> |
| <td>bool</td> |
| <td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td> |
| <td>bool</td> |
| <td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td> |
| <td>string</td> |
| <td>The origin server base URL (FQDN when used in this instance, includes the |
| protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> |
| <td>string</td> |
| <td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> |
| <td>string</td> |
| <td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td> |
| <td>string</td> |
| <td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td> |
| <td>string</td> |
| <td><ul class="first last simple"> |
| <li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li> |
| <li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li> |
| <li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> |
| <td>string</td> |
| <td><ul class="first last simple"> |
| <li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> |
| <li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> |
| <li>2: drop query string at edge, and do not use it in the cache-key.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>string</td> |
| <td><p class="first">How to treat range requests:</p> |
| <ul class="last simple"> |
| <li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> |
| <li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li> |
| <li>2 Use the cache_range_requests plugin.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td> |
| <td>string</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> |
| <td>bool</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td> |
| <td>string</td> |
| <td>Additional raw remap line text.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> |
| <li>true: token based auth is enabled for this deliveryservice.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> |
| <td>string</td> |
| <td>Owning tenant name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> |
| <td>string</td> |
| <td>Unique string that describes this deliveryservice.</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">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> |
| <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> |
| <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> |
| <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> |
| <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> |
| <span class="p">],</span> |
| <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> |
| <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> |
| <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> |
| <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> |
| <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> |
| <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> |
| <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> |
| <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> |
| <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> |
| <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> |
| <span class="p">}</span> |
| <span class="p">{</span> <span class="o">..</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/user/current</strong></p> |
| <blockquote> |
| <div><p>Retrieves the profile for the authenticated user.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="11%" /> |
| <col width="61%" /> |
| </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">email</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> |
| <td>string</td> |
| <td>Owning tenant name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID</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">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span> |
| <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span> |
| <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span> |
| <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</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/user/current</strong></p> |
| <blockquote> |
| <div><p>Updates the date for the authenticated user.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="11%" /> |
| <col width="61%" /> |
| </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">email</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID</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">"user"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span> |
| <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</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> |
| <blockquote> |
| <div><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> |
| <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">"UserProfile was successfully updated."</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/user/current/jobs.json</strong></p> |
| <blockquote> |
| <div><p>Retrieves the user’s list of jobs.</p> |
| <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="16%" /> |
| <col width="63%" /> |
| </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">keyword</span></code></td> |
| <td>no</td> |
| <td>PURGE</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">keyword</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">objectName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetType</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dsXmlId</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">enteredTime</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">objectType</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">agent</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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"><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">"1"</span><span class="p">,</span> |
| <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span> |
| <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> |
| <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span> |
| <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span> |
| <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span> |
| <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span> |
| <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span> |
| <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span> |
| <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</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/user/current/jobs</strong></p> |
| <p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p> |
| </div> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <blockquote> |
| <div><p><strong>Request 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">dsId</span></code></td> |
| <td>string</td> |
| <td>Unique Delivery Service ID</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">regex</span></code></td> |
| <td>string</td> |
| <td>Path Regex this should be a |
| <a class="reference external" href="http://www.pcre.org/">PCRE</a> compatible |
| regular expression for the path to match for |
| forcing the revalidation. Be careful to only |
| match on the content you need to remove - |
| revalidation is an expensive operation for |
| many origins, and a simple <code class="docutils literal"><span class="pre">/.*</span></code> can cause |
| an overload condition of the origin.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> |
| <td>string</td> |
| <td>Start Time is the time when the revalidation |
| rule will be made active. Populate |
| with the current time to schedule ASAP. This |
| value cannot be more than 2 days before now.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td> |
| <td>int</td> |
| <td>Time To Live is how long the revalidation rule |
| will be active for in hours. It usually makes |
| sense to make this the same as the |
| <code class="docutils literal"><span class="pre">Cache-Control</span></code> header from the origin which |
| sets the object time to live in cache |
| (by <code class="docutils literal"><span class="pre">max-age</span></code> or <code class="docutils literal"><span class="pre">Expires</span></code>). Entering a |
| longer TTL here will make the caches do |
| unnecessary work.</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">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span> |
| <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span> |
| <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span> |
| <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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="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> |
| <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">"Successfully created purge job for: ."</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/user/login</strong></p> |
| <blockquote> |
| <div><p>Authentication of a user using username and password. Traffic Ops will send back a session cookie.</p> |
| <p>Authentication Required: No</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request 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">u</span></code></td> |
| <td>string</td> |
| <td>username</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">p</span></code></td> |
| <td>string</td> |
| <td>password</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">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span> |
| <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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="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> |
| <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">"Successfully logged in."</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/user/:id/deliveryservices/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="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>id</td> |
| <td>yes</td> |
| <td> </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">id</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </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">"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">"90"</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Bar DS"</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-bar"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"92"</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Baz DS"</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-baz"</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/user/login/token</strong></p> |
| <blockquote> |
| <div><p>Authentication of a user using a token.</p> |
| <p>Authentication Required: No</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request 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">t</span></code></td> |
| <td>string</td> |
| <td>token-value</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">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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="38%" /> |
| <col width="24%" /> |
| <col width="38%" /> |
| </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> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td> </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> |
| <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">"error"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</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/user/logout</strong></p> |
| <blockquote> |
| <div><p>User logout. Invalidates the session cookie.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><ul class="first last simple"> |
| <li><code class="docutils literal"><span class="pre">level</span></code></li> |
| </ul> |
| </td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><ul class="first last simple"> |
| <li><code class="docutils literal"><span class="pre">text</span></code></li> |
| </ul> |
| </td> |
| <td>string</td> |
| <td> </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> |
| <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">"You are logged out."</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/user/reset_password</strong></p> |
| <blockquote> |
| <div><p>Reset user password.</p> |
| <p>Authentication Required: No</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request 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">email</span></code></td> |
| <td>string</td> |
| <td>The email address of the user to initiate |
| password reset.</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><ul class="first last simple"> |
| <li><code class="docutils literal"><span class="pre">level</span></code></li> |
| </ul> |
| </td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><ul class="first last simple"> |
| <li><code class="docutils literal"><span class="pre">text</span></code></li> |
| </ul> |
| </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> |
| <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">"Successfully sent password reset to email 'email@email.com'"</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="topology.html" class="btn btn-neutral float-right" title="Snapshot CRConfig">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="type.html" class="btn btn-neutral" title="Types"><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> |
