http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/influxdb.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/influxdb.html b/docs/latest/development/traffic_ops_api/v12/influxdb.html index 4a31ea5..208dcde 100644 --- a/docs/latest/development/traffic_ops_api/v12/influxdb.html +++ b/docs/latest/development/traffic_ops_api/v12/influxdb.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>InfluxDB — Traffic Control master documentation </title> + <title>InfluxDB — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <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="Regions" href="region.html"/> <link rel="prev" title="Profile parameters" href="profile_parameter.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> @@ -216,28 +221,28 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"aaData"</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">"aaData"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> - <span class="s">"0"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"true"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"142035"</span><span class="p">,</span> - <span class="s">"172365661.85"</span> + <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"true"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"142035"</span><span class="p">,</span> + <span class="s2">"172365661.85"</span> <span class="p">],</span> <span class="p">[</span> <span class="mi">1</span><span class="p">,</span> - <span class="s">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span> - <span class="s">"odol-atsec-atl-03"</span><span class="p">,</span> - <span class="s">"us-ga-atlanta"</span><span class="p">,</span> - <span class="s">"1"</span><span class="p">,</span> - <span class="s">"REPORTED"</span><span class="p">,</span> - <span class="s">"596"</span><span class="p">,</span> - <span class="s">"923510.04"</span><span class="p">,</span> - <span class="s">"69.241.82.126"</span> + <span class="s2">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span> + <span class="s2">"odol-atsec-atl-03"</span><span class="p">,</span> + <span class="s2">"us-ga-atlanta"</span><span class="p">,</span> + <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"REPORTED"</span><span class="p">,</span> + <span class="s2">"596"</span><span class="p">,</span> + <span class="s2">"923510.04"</span><span class="p">,</span> + <span class="s2">"69.241.82.126"</span> <span class="p">]</span> <span class="p">],</span> <span class="p">}</span> @@ -283,10 +288,11 @@ <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/job.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/job.html b/docs/latest/development/traffic_ops_api/v12/job.html new file mode 100644 index 0000000..531b297 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/job.html @@ -0,0 +1,438 @@ + + +<!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>Jobs — 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="Parameter" href="parameter.html"/> + <link rel="prev" title="Hardware Info" href="hwinfo.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>Jobs</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/job.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="jobs"> +<span id="to-api-v12-job"></span><h1>Jobs<a class="headerlink" href="#jobs" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-jobs"> +<span id="to-api-v12-job-route"></span><h2>/api/1.2/jobs<a class="headerlink" href="#api-1-2-jobs" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/jobs</strong></p> +<blockquote> +<div><p>Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending).</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Operations or Admin</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>no</td> +<td>Filter jobs by Delivery Service ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">userId</span></code></td> +<td>no</td> +<td>Filter jobs by 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">id</span></code></td> +<td>int</td> +<td>Job id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td>URL of the asset to invalidate.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td> +<td>string</td> +<td>Unique identifier of the job’s DS.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">keyword</span></code></td> +<td>string</td> +<td>Job keyword (PURGE)</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> +<td>string</td> +<td>Parameters associated with the job.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td>Start time of the job.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">createdBy</span></code></td> +<td>string</td> +<td>Username that initiated the job.</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="mi">1</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</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">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/bell.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</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">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:72h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-16 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</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/jobs/:id</strong></p> +<blockquote> +<div><p>Get a job by ID (currently limited to invalidate content (PURGE) jobs).</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Operations or Admin</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">id</span></code></td> +<td>int</td> +<td>Job id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td>URL of the asset to invalidate.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td> +<td>string</td> +<td>Unique identifier of the job’s DS.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">keyword</span></code></td> +<td>string</td> +<td>Job keyword (PURGE)</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> +<td>string</td> +<td>Parameters associated with the job.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td>Start time of the job.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">createdBy</span></code></td> +<td>string</td> +<td>Username that initiated the job.</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="mi">1</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</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">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</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="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/parameter.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/parameter.html b/docs/latest/development/traffic_ops_api/v12/parameter.html index eef0aae..d6e63df 100644 --- a/docs/latest/development/traffic_ops_api/v12/parameter.html +++ b/docs/latest/development/traffic_ops_api/v12/parameter.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Parameter — Traffic Control master documentation </title> + <title>Parameter — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <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="Physical Location" href="phys_location.html"/> - <link rel="prev" title="Hardware Info" href="hwinfo.html"/> + <link rel="prev" title="Jobs" href="job.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -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> @@ -180,7 +185,7 @@ <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -231,28 +236,28 @@ </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">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -303,15 +308,15 @@ </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">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span><span class="p">,</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span><span class="p">,</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -383,13 +388,13 @@ </div></blockquote> </div></blockquote> <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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -399,13 +404,185 @@ <div class="line-block"> <div class="line"><br /></div> </div> -<p><strong>GET /api/1.2/profiles/:id/parameters</strong></p> +<p><strong>GET /api/1.2/parameters/:id/unassigned_profiles</strong></p> +<blockquote> +<div><blockquote> +<div><p>Retrieves all profiles NOT assigned to the parameter.</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="19%" /> +<col width="13%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Parameter ID.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="10%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>array</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>The name for the profile</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Primary key</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td>The description for the profile</td> +</tr> +</tbody> +</table> +</div></blockquote> +</div></blockquote> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/profiles/:id/parameters</strong></p> +<blockquote> +<div><p>Retrieves all parameters assigned to the profile.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="35%" /> +<col width="20%" /> +<col width="45%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Profile id</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="8%" /> +<col width="75%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">last_updated</span></code></td> +<td>string</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td> +<td>boolean</td> +<td>When true, the parameter is accessible only by admin users. Defaults to false.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td> +<td>string</td> +<td>The parameter value, only visible to admin if secure is true</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>The parameter name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td> +<td>string</td> +<td>The parameter config_file</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/profiles/:id/unassigned_parameters</strong></p> +<blockquote> +<div><p>Retrieves all parameters NOT assigned to the profile.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> <col width="35%" /> <col width="20%" /> <col width="45%" /> @@ -460,28 +637,28 @@ </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">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -552,28 +729,28 @@ </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">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> - <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span> + <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> + <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -714,28 +891,28 @@ The request route parameters accept 2 formats, both single paramter and paramete <p><strong>Request Example</strong></p> <ol class="arabic"> <li><p class="first">single parameter format example:</p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="mi">0</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span> <span class="p">}</span> </pre></div> </div> </li> <li><p class="first">array format example:</p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="mi">0</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param2"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile2"</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value2"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="mi">1</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span> <span class="p">}</span> <span class="p">]</span> </pre></div> @@ -743,21 +920,21 @@ The request route parameters accept 2 formats, both single paramter and paramete </li> </ol> <p><strong>Response Example</strong></p> -<div class="last 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="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span><span class="s">"1139"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1139"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value2"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param2"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span><span class="s">"1140"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile2"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1140"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -868,22 +1045,22 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> <span class="p">}</span> </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="last 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">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> @@ -952,12 +1129,12 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> +<div class="last 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">"Parameter was successfully deleted."</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">"Parameter was successfully deleted."</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -1038,21 +1215,21 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span><span class="p">,</span> - <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span> <span class="p">}</span> </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="last 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">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span> - <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span> - <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> @@ -1074,7 +1251,7 @@ The request route parameters accept 2 formats, both single paramter and paramete <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -1103,10 +1280,11 @@ The request route parameters accept 2 formats, both single paramter and paramete <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>
