http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v11/user.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v11/user.html b/docs/latest/development/traffic_ops_api/v11/user.html index 948fb67..364546b 100644 --- a/docs/latest/development/traffic_ops_api/v11/user.html +++ b/docs/latest/development/traffic_ops_api/v11/user.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Users — Traffic Control master documentation </title> + <title>Users — Traffic Control 2.1-dev documentation </title> @@ -33,9 +33,9 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <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="ASN" href="../v12/asn.html"/> + <link rel="next" title="API-Capabilities" href="../v12/api_capability.html"/> <link rel="prev" title="Types" href="type.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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> @@ -118,10 +121,12 @@ </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> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -177,7 +182,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../v12/asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="../v12/api_capability.html" class="btn btn-neutral float-right" title="API-Capabilities">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> @@ -292,29 +297,29 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"ema...@email.com"</span><span class="p">,</span> - <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</span><span class="p">,</span> - <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</span><span class="p">,</span> - <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span> - <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> - <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"admin"</span><span class="p">,</span> - <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</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">"ema...@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">"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> @@ -449,29 +454,29 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"ema...@email.com"</span><span class="p">,</span> - <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</span><span class="p">,</span> - <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</span><span class="p">,</span> - <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span> - <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> - <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"admin"</span><span class="p">,</span> - <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</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">"ema...@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">"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="p">}</span> @@ -571,25 +576,25 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"em...@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span> - <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span> - <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span> - <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> - <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span> +<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">"em...@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="p">}</span> </pre></div> @@ -688,25 +693,25 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span> - <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> - <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> - <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span> +<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="p">}</span> </pre></div> @@ -744,11 +749,11 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</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> @@ -860,23 +865,23 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span> - <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span> - <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span> - <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span> - <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span> - <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span> - <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span> - <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span> - <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span> - <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</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> @@ -944,11 +949,11 @@ unnecessary work.</td> </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span> - <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span> - <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span> - <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span> +<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> @@ -990,12 +995,12 @@ unnecessary work.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</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> @@ -1035,9 +1040,9 @@ unnecessary work.</td> </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span> - <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span> +<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> @@ -1079,11 +1084,11 @@ unnecessary work.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</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> @@ -1142,15 +1147,15 @@ unnecessary work.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span> + <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</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="p">{</span> - <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span> + <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -1186,8 +1191,8 @@ unnecessary work.</td> </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span> +<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> @@ -1229,11 +1234,11 @@ unnecessary work.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</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> @@ -1287,11 +1292,11 @@ unnecessary work.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</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> @@ -1328,8 +1333,8 @@ password reset.</td> </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"em...@email.com"</span> +<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">"em...@email.com"</span> <span class="p">}</span> </pre></div> </div> @@ -1377,11 +1382,11 @@ password reset.</td> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'em...@email.com'"</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 'em...@email.com'"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -1397,7 +1402,7 @@ password reset.</td> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../v12/asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="../v12/api_capability.html" class="btn btn-neutral float-right" title="API-Capabilities">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> @@ -1429,10 +1434,11 @@ password reset.</td> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.html b/docs/latest/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.html new file mode 100644 index 0000000..737e790 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.html @@ -0,0 +1,426 @@ + + +<!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><no title> — Traffic Control 1.8-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 1.8-dev documentation" href="../../../index.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_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><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 1.8-dev</a> »</li> + + <li><no title></li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div role="main" class="document"> + + <p>Config Files and Config File Metadata +===</p> +<p id="to-api-v12-configfiles-route">/api/1.2/servers/:hostname/configfiles/ats +/api/1.2/servers/:host_id/configfiles/ats ++++++++++++++</p> +<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats</strong> +<strong>GET /api/1.2/servers/:host_id/configfiles/ats</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: Operator</p> +<p><strong>Request Query Parameters</strong></p> +<p><strong>Response Properties</strong></p> +<p>+======================================================================================================+ +| Info Section | ++——————-+——–+————————————————————————-+ +| Parameter | Type | Description | ++===================+========+=========================================================================+ +| <code class="docutils literal"><span class="pre">profileId</span></code> | string | The ID of the profile assigned to the cache. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">profileName</span></code> | string | The name of the profile assigned to the cache. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">toRevProxyUrl</span></code> | string | The configured reverse proxy cache for configfile requests. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">toURL</span></code> | string | The configured URL for Traffic Ops. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverIpv4</span></code> | string | The configured IP address of the cache. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverName</span></code> | string | The cache’s short form hostname. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverId</span></code> | string | The cache’s Traffic Ops ID. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">cdnId</span></code> | string | The ID of the cache’s assigned CDN. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">cdnName</span></code> | string | The name of the cache’s assigned CDN. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | ++======================================================================================================+ +| configFiles Section | ++——————-+——–+————————————————————————-+ +| Parameter | Type | Description | ++===================+========+=========================================================================+ +| <code class="docutils literal"><span class="pre">fnameOnDisk</span></code> | string | The filename of the configuration file as stored on the cache. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">location</span></code> | string | The directory location of the configuration file as stored on the cache.| ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">apiUri</span></code> | string | The path to generate the configuration file from Traffic Ops. | ++——————-+——–+————————————————————————-+ +| <code class="docutils literal"><span class="pre">scope</span></code> | string | The scope of the configuration file. | ++——————-+——–+————————————————————————-+</p> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +</pre></div> +</div> +<blockquote> +<div><dl class="docutils"> +<dt>“info”: {</dt> +<dd>“profileId”: 278, +“toRevProxyUrl”: “<a class="reference external" href="https://to.example.com:81";>https://to.example.com:81</a>”, +“toUrl”: “<a class="reference external" href="https://to.example.com/";>https://to.example.com/</a>”, +“serverIpv4”: “192.168.1.5”, +“serverTcpPort”: 80, +“serverName”: “cache-ats-01”, +“cdnId”: 1, +“cdnName”: “CDN_1”, +“serverId”: 21, +“profileName”: “EDGE_CDN_1_EXAMPLE”</dd> +</dl> +<p>}, +“configFiles”: [</p> +<blockquote> +<div><dl class="docutils"> +<dt>{</dt> +<dd>“fnameOnDisk”: “remap.config”, +“location”: “/opt/trafficserver/etc/trafficserver”, +“apiUri”: “/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config”, +“scope”: “profiles”</dd> +</dl> +<p>}, +{</p> +<blockquote> +<div>“fnameOnDisk”: “ssl_multicert.config”, +“location”: “/opt/trafficserver/etc/trafficserver”, +“apiUri”: “/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config”, +“scope”: “cdns”</div></blockquote> +<p>}, +{</p> +<blockquote> +<div>“fnameOnDisk”: “parent.config”, +“location”: “/opt/trafficserver/etc/trafficserver”, +“apiUri”: “/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config”</div></blockquote> +<p>}</p> +</div></blockquote> +<p>]</p> +</div></blockquote> +<p>}</p> +</div></blockquote> +<p>/api/1.2/servers/:hostname/configfiles/ats/:configfile +/api/1.2/servers/:host_id/configfiles/ats/:configfile ++++++++++++++</p> +<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats/:configfile</strong> +<strong>GET /api/1.2/servers/:host_id/configfiles/ats/:configfile</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: Operator</p> +<p><strong>Request Query Parameters</strong></p> +<p><strong>Response Properties</strong></p> +<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +</pre></div> +</div> +<blockquote> +<div><dl class="docutils"> +<dt>“alerts”: [</dt> +<dd><dl class="first docutils"> +<dt>{</dt> +<dd>“level”: “error”, +“text”: “Error - incorrect file scope for route used. Please use the profiles route.”</dd> +</dl> +<p class="last">}</p> +</dd> +</dl> +<p>]</p> +</div></blockquote> +<p>}</p> +</div></blockquote> +<p>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile +/api/1.2/profiles/:profile_id/configfiles/ats/:configfile ++++++++++++++</p> +<p><strong>GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile</strong> +<strong>GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: Operator</p> +<p><strong>Request Query Parameters</strong></p> +<p><strong>Response Properties</strong></p> +<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +</pre></div> +</div> +<blockquote> +<div><dl class="docutils"> +<dt>“alerts”: [</dt> +<dd><dl class="first docutils"> +<dt>{</dt> +<dd>“level”: “error”, +“text”: “Error - incorrect file scope for route used. Please use the cdns route.”</dd> +</dl> +<p class="last">}</p> +</dd> +</dl> +<p>]</p> +</div></blockquote> +<p>}</p> +</div></blockquote> +<p>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile +/api/1.2/cdns/:cdn_id/configfiles/ats/:configfile ++++++++++++++</p> +<p><strong>GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</strong> +<strong>GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: Operator</p> +<p><strong>Request Query Parameters</strong></p> +<p><strong>Response Properties</strong></p> +<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +</pre></div> +</div> +<blockquote> +<div><dl class="docutils"> +<dt>“alerts”: [</dt> +<dd><dl class="first docutils"> +<dt>{</dt> +<dd>“level”: “error”, +“text”: “Error - incorrect file scope for route used. Please use the servers route.”</dd> +</dl> +<p class="last">}</p> +</dd> +</dl> +<p>]</p> +</div></blockquote> +<p>}</p> +</div></blockquote> + + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../../', + VERSION:'1.8-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
