blob: 9dd83e282500872595a5aa9e35b76685da15117e [file] [log] [blame]
<!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>Server &mdash; 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="Static DNS Entries" href="static_dns.html"/>
<link rel="prev" title="Roles" href="role.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&#8217;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&#8217;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>
&nbsp;
</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> &raquo;</li>
<li><a href="../../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../../traffic_ops.html">Traffic Ops</a> &raquo;</li>
<li>Server</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v12/server.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="static_dns.html" class="btn btn-neutral float-right" title="Static DNS Entries">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="role.html" class="btn btn-neutral" title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="server">
<span id="to-api-v12-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline"></a></h1>
<div class="section" id="api-1-2-servers">
<span id="to-api-v12-servers-route"></span><h2>/api/1.2/servers<a class="headerlink" href="#api-1-2-servers" title="Permalink to this headline"></a></h2>
<p><strong>GET /api/1.2/servers</strong></p>
<blockquote>
<div><p>Retrieves properties of CDN servers.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="13%" />
<col width="60%" />
</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>Used to filter servers by delivery service.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>no</td>
<td>Used to filter servers by status.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>no</td>
<td>Used to filter servers by type.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>no</td>
<td>Used to filter servers by profile ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
<td>no</td>
<td>Used to filter servers by CDN ID.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>no</td>
<td>Used to filter servers by cache group ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>no</td>
<td>Used to filter servers by phys location ID.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="6%" />
<col width="79%" />
</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">cachegroup</span></code></td>
<td>string</td>
<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
<td>string</td>
<td>The cache group id.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
<td>string</td>
<td>Id of the CDN to which the server belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>string</td>
<td>Name of the CDN to which the server belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
<td>string</td>
<td>An identifier used to uniquely identify the server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an &#8216;admin&#8217; user).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
<td>string</td>
<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
<td>string</td>
<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
<td>bool</td>
<td>&nbsp;</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-il-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroupId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s2">&quot;CDN-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;domainName&quot;</span><span class="p">:</span> <span class="s2">&quot;chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;guid&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;hostName&quot;</span><span class="p">:</span> <span class="s2">&quot;atsec-chi-00&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;19&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.6&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloPassword&quot;</span><span class="p">:</span> <span class="s2">&quot;********&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloUsername&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceMtu&quot;</span><span class="p">:</span> <span class="s2">&quot;9000&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceName&quot;</span><span class="p">:</span> <span class="s2">&quot;bond0&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Address&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:2/64&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Gateway&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.2&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2015-03-08 15:57:32&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;offlineReason&quot;</span><span class="p">:</span> <span class="s2">&quot;N/A&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocation&quot;</span><span class="p">:</span> <span class="s2">&quot;plocation-chi-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocationId&quot;</span><span class="p">:</span> <span class="s2">&quot;9&quot;</span><span class="p">,</span>
<span class="s2">&quot;profile&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421_SSL&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileDesc&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421_SSL profile&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileId&quot;</span><span class="p">:</span> <span class="s2">&quot;12&quot;</span><span class="p">,</span>
<span class="s2">&quot;rack&quot;</span><span class="p">:</span> <span class="s2">&quot;RR 119.02&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerHostName&quot;</span><span class="p">:</span> <span class="s2">&quot;rtr-chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerPortName&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="s2">&quot;ONLINE&quot;</span><span class="p">,</span>
<span class="s2">&quot;statusId&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcpPort&quot;</span><span class="p">:</span> <span class="s2">&quot;80&quot;</span><span class="p">,</span>
<span class="s2">&quot;httpsPort&quot;</span><span class="p">:</span> <span class="s2">&quot;443&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;updPending&quot;</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</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/servers/:id</strong></p>
<blockquote>
<div><p>Retrieves properties of a CDN server by server ID.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="15%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>yes</td>
<td>Server id.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="6%" />
<col width="79%" />
</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">cachegroup</span></code></td>
<td>string</td>
<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
<td>string</td>
<td>The cache group id.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
<td>string</td>
<td>Id of the CDN to which the server belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>string</td>
<td>Name of the CDN to which the server belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
<td>string</td>
<td>An identifier used to uniquely identify the server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an &#8216;admin&#8217; user).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
<td>string</td>
<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
<td>string</td>
<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
<td>bool</td>
<td>&nbsp;</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-il-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroupId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s2">&quot;CDN-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;domainName&quot;</span><span class="p">:</span> <span class="s2">&quot;chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;guid&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;hostName&quot;</span><span class="p">:</span> <span class="s2">&quot;atsec-chi-00&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;19&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.6&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloPassword&quot;</span><span class="p">:</span> <span class="s2">&quot;********&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloUsername&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceMtu&quot;</span><span class="p">:</span> <span class="s2">&quot;9000&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceName&quot;</span><span class="p">:</span> <span class="s2">&quot;bond0&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Address&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:2/64&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Gateway&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.2&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2015-03-08 15:57:32&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;offlineReason&quot;</span><span class="p">:</span> <span class="s2">&quot;N/A&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocation&quot;</span><span class="p">:</span> <span class="s2">&quot;plocation-chi-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocationId&quot;</span><span class="p">:</span> <span class="s2">&quot;9&quot;</span><span class="p">,</span>
<span class="s2">&quot;profile&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421_SSL&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileDesc&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421_SSL profile&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileId&quot;</span><span class="p">:</span> <span class="s2">&quot;12&quot;</span><span class="p">,</span>
<span class="s2">&quot;rack&quot;</span><span class="p">:</span> <span class="s2">&quot;RR 119.02&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerHostName&quot;</span><span class="p">:</span> <span class="s2">&quot;rtr-chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerPortName&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="s2">&quot;ONLINE&quot;</span><span class="p">,</span>
<span class="s2">&quot;statusId&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcpPort&quot;</span><span class="p">:</span> <span class="s2">&quot;80&quot;</span><span class="p">,</span>
<span class="s2">&quot;httpsPort&quot;</span><span class="p">:</span> <span class="s2">&quot;443&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;updPending&quot;</span><span class="p">:</span> <span class="n">false</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/servers/:id/deliveryservices</strong></p>
<blockquote>
<div><p>Retrieves all delivery services assigned to the server. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="13%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>yes</td>
<td>Server ID.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="5%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
<td>string</td>
<td>Id of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>string</td>
<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
<td>string</td>
<td>The display name of the delivery service.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -&gt; customer) traffic.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
<li>1: Only route on CZF file hit</li>
<li>2: Only route on CZF hit or when from USA</li>
</ul>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
<td>bool</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=&#8217;regex&#8217;).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;&gt;setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
<td>The MID header rewrite actions to perform.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
<td>string</td>
<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
<li>2 Use the cache_range_requests plugin.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
<td>bool</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td>
<td>string</td>
<td>Owning tenant name</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
<td>int</td>
<td>Owning tenant ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=&#8217;deliveryservice&#8217;).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=&#8217;deliveryservice&#8217;).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
<td>string</td>
<td>Unique string that describes this deliveryservice.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;active&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s2">&quot;cacheurl&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;ccrDnsTtl&quot;</span><span class="p">:</span> <span class="s2">&quot;3600&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnId&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s2">&quot;over-the-top&quot;</span><span class="p">,</span>
<span class="s2">&quot;checkPath&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;displayName&quot;</span><span class="p">:</span> <span class="s2">&quot;My Cool Delivery Service&quot;</span><span class="p">,</span>
<span class="s2">&quot;dnsBypassCname&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;dnsBypassIp&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;dnsBypassIp6&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;dnsBypassTtl&quot;</span><span class="p">:</span> <span class="s2">&quot;30&quot;</span><span class="p">,</span>
<span class="s2">&quot;dscp&quot;</span><span class="p">:</span> <span class="s2">&quot;40&quot;</span><span class="p">,</span>
<span class="s2">&quot;edgeHeaderRewrite&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;exampleURLs&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">&quot;http://edge.foo-ds.foo.bar.net&quot;</span>
<span class="p">],</span>
<span class="s2">&quot;geoLimit&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;geoLimitCountries&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;geoLimitRedirectURL&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;geoProvider&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;globalMaxMbps&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;globalMaxTps&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;httpBypassFqdn&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;442&quot;</span><span class="p">,</span>
<span class="s2">&quot;infoUrl&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;initialDispersion&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipv6RoutingEnabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2016-01-26 08:49:35&quot;</span><span class="p">,</span>
<span class="s2">&quot;logsEnabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;longDesc&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;longDesc1&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;longDesc2&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;matchList&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;pattern&quot;</span><span class="p">:</span> <span class="s2">&quot;.*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*&quot;</span><span class="p">,</span>
<span class="s2">&quot;setNumber&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;HOST_REGEXP&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">&quot;maxDnsAnswers&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;midHeaderRewrite&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;missLat&quot;</span><span class="p">:</span> <span class="s2">&quot;41.881944&quot;</span><span class="p">,</span>
<span class="s2">&quot;missLong&quot;</span><span class="p">:</span> <span class="s2">&quot;-87.627778&quot;</span><span class="p">,</span>
<span class="s2">&quot;multiSiteOrigin&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;multiSiteOriginAlgorithm&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;orgServerFqdn&quot;</span><span class="p">:</span> <span class="s2">&quot;http://baz.boo.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;originShield&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;profileDescription&quot;</span><span class="p">:</span> <span class="s2">&quot;Content Router for over-the-top&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileId&quot;</span><span class="p">:</span> <span class="s2">&quot;5&quot;</span><span class="p">,</span>
<span class="s2">&quot;profileName&quot;</span><span class="p">:</span> <span class="s2">&quot;ROUTER_TOP&quot;</span><span class="p">,</span>
<span class="s2">&quot;protocol&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;qstringIgnore&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
<span class="s2">&quot;rangeRequestHandling&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;regexRemap&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;regionalGeoBlocking&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;remapText&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;signed&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s2">&quot;sslKeyVersion&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
<span class="s2">&quot;tenant&quot;</span><span class="p">:</span> <span class="s2">&quot;root&quot;</span><span class="p">,</span>
<span class="s2">&quot;tenantId&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">&quot;trRequestHeaders&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s2">&quot;trResponseHeaders&quot;</span><span class="p">:</span> <span class="s2">&quot;Access-Control-Allow-Origin: *&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;HTTP&quot;</span><span class="p">,</span>
<span class="s2">&quot;typeId&quot;</span><span class="p">:</span> <span class="s2">&quot;8&quot;</span><span class="p">,</span>
<span class="s2">&quot;xmlId&quot;</span><span class="p">:</span> <span class="s2">&quot;foo-ds&quot;</span>
<span class="p">}</span>
<span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
<span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>GET /api/1.2/servers/totals</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="12%" />
<col width="9%" />
<col width="79%" />
</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">count</span></code></td>
<td>int</td>
<td>The number of servers of this type in this instance of Traffic Ops.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;count&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;CCR&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;count&quot;</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;MID&quot;</span><span class="p">,</span>
<span class="s2">&quot;count&quot;</span><span class="p">:</span> <span class="mi">18</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;count&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;INFLUXDB&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">&quot;count&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;RASCAL&quot;</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/servers/status</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by status.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="12%" />
<col width="6%" />
<col width="83%" />
</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">ONLINE</span></code></td>
<td>int</td>
<td>The number of ONLINE servers. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">REPORTED</span></code></td>
<td>int</td>
<td>The number of REPORTED servers. Traffic Monitor monitors the state of REPORTED servers and removes them if unhealthy.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">OFFLINE</span></code></td>
<td>int</td>
<td>The number of OFFLINE servers. Used for longer-term maintenance. These servers are excluded from CRConfig.json.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ADMIN_DOWN</span></code></td>
<td>int</td>
<td>The number of ADMIN_DOWN servers. Used for short-term maintenance. These servers are included in CRConfig.json.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">CCR_IGNORE</span></code></td>
<td>int</td>
<td>The number of CCR_IGNORE servers. These servers are excluded from CRConfig.json.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">PRE_PROD</span></code></td>
<td>int</td>
<td>The number of PRE_PROD servers. Used for servers to be deployed. These servers are excluded from CRConfig.json.</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">&quot;response&quot;</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">&quot;ONLINE&quot;</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
<span class="s2">&quot;OFFLINE&quot;</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span>
<span class="s2">&quot;REPORTED&quot;</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
<span class="s2">&quot;ADMIN_DOWN&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s2">&quot;CCR_IGNORE&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">&quot;PRE_PROD&quot;</span><span class="p">:</span> <span class="mi">0</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/servers/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</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="19%" />
<col width="19%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>yes</td>
<td>The host name part of the cache.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="6%" />
<col width="78%" />
</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">cachegroup</span></code></td>
<td>string</td>
<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an &#8216;admin&#8217; user).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time/Date of the last update for this server.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
<td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
<td>Deprecated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppPasswd</span></code></td>
<td>string</td>
<td>Deprecated.</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;us-il-chicago&quot;</span><span class="p">,</span>
<span class="s2">&quot;deliveryservices&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s2">&quot;1&quot;</span><span class="p">,</span>
<span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;3&quot;</span><span class="p">,</span>
<span class="s2">&quot;4&quot;</span>
<span class="p">],</span>
<span class="s2">&quot;domainName&quot;</span><span class="p">:</span> <span class="s2">&quot;chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;hardwareInfo&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;Physical Disk 0:1:3&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:2&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:15&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Power Supply.Slot.2&quot;</span><span class="p">:</span> <span class="s2">&quot;04.07.15&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:24&quot;</span><span class="p">:</span> <span class="s2">&quot;YS08&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:1&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Model&quot;</span><span class="p">:</span> <span class="s2">&quot;PowerEdge R720xd&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:22&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:18&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Enterprise UEFI Diagnostics&quot;</span><span class="p">:</span> <span class="s2">&quot;4217A5&quot;</span><span class="p">,</span>
<span class="s2">&quot;Lifecycle Controller&quot;</span><span class="p">:</span> <span class="s2">&quot;1.0.8.42&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:8&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Manufacturer&quot;</span><span class="p">:</span> <span class="s2">&quot;Dell Inc.&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:6&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;SysMemTotalSize&quot;</span><span class="p">:</span> <span class="s2">&quot;196608&quot;</span><span class="p">,</span>
<span class="s2">&quot;PopulatedDIMMSlots&quot;</span><span class="p">:</span> <span class="s2">&quot;24&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:20&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Intel(R) Ethernet 10G 2P X520 Adapter&quot;</span><span class="p">:</span> <span class="s2">&quot;13.5.7&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:14&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;BACKPLANE FIRMWARE&quot;</span><span class="p">:</span> <span class="s2">&quot;1.00&quot;</span><span class="p">,</span>
<span class="s2">&quot;Dell OS Drivers Pack, 7.0.0.29, A00&quot;</span><span class="p">:</span> <span class="s2">&quot;7.0.0.29&quot;</span><span class="p">,</span>
<span class="s2">&quot;Integrated Dell Remote Access Controller&quot;</span><span class="p">:</span> <span class="s2">&quot;1.57.57&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:5&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;ServiceTag&quot;</span><span class="p">:</span> <span class="s2">&quot;D6XPDV1&quot;</span><span class="p">,</span>
<span class="s2">&quot;PowerState&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:23&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:25&quot;</span><span class="p">:</span> <span class="s2">&quot;D903&quot;</span><span class="p">,</span>
<span class="s2">&quot;BIOS&quot;</span><span class="p">:</span> <span class="s2">&quot;1.3.6&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:12&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;System CPLD&quot;</span><span class="p">:</span> <span class="s2">&quot;1.0.3&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:4&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:0&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Power Supply.Slot.1&quot;</span><span class="p">:</span> <span class="s2">&quot;04.07.15&quot;</span><span class="p">,</span>
<span class="s2">&quot;PERC H710P Mini&quot;</span><span class="p">:</span> <span class="s2">&quot;21.0.2-0001&quot;</span><span class="p">,</span>
<span class="s2">&quot;PowerCap&quot;</span><span class="p">:</span> <span class="s2">&quot;689&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:16&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:10&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:11&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Lifecycle Controller 2&quot;</span><span class="p">:</span> <span class="s2">&quot;1.0.8.42&quot;</span><span class="p">,</span>
<span class="s2">&quot;BP12G+EXP 0:1&quot;</span><span class="p">:</span> <span class="s2">&quot;1.07&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:9&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:17&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Broadcom Gigabit Ethernet BCM5720&quot;</span><span class="p">:</span> <span class="s2">&quot;7.2.20&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:21&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:13&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:7&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span><span class="p">,</span>
<span class="s2">&quot;Physical Disk 0:1:19&quot;</span><span class="p">:</span> <span class="s2">&quot;D1S2&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hostName&quot;</span><span class="p">:</span> <span class="s2">&quot;atsec-chi-00&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;19&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.6&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;172.16.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloPassword&quot;</span><span class="p">:</span> <span class="s2">&quot;********&quot;</span><span class="p">,</span>
<span class="s2">&quot;iloUsername&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceMtu&quot;</span><span class="p">:</span> <span class="s2">&quot;9000&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceName&quot;</span><span class="p">:</span> <span class="s2">&quot;bond0&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Address&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:2/64&quot;</span><span class="p">,</span>
<span class="s2">&quot;ip6Gateway&quot;</span><span class="p">:</span> <span class="s2">&quot;2033:D0D0:3300::2:1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.2&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;10.10.2.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;mgmtIpNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocation&quot;</span><span class="p">:</span> <span class="s2">&quot;plocation-chi-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;profile&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421_SSL&quot;</span><span class="p">,</span>
<span class="s2">&quot;rack&quot;</span><span class="p">:</span> <span class="s2">&quot;RR 119.02&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerHostName&quot;</span><span class="p">:</span> <span class="s2">&quot;rtr-chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s2">&quot;routerPortName&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
<span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="s2">&quot;ONLINE&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcpPort&quot;</span><span class="p">:</span> <span class="s2">&quot;80&quot;</span><span class="p">,</span>
<span class="s2">&quot;httpsPort&quot;</span><span class="p">:</span> <span class="s2">&quot;443&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE&quot;</span><span class="p">,</span>
<span class="s2">&quot;xmppId&quot;</span><span class="p">:</span> <span class="s2">&quot;atsec-chi-00-dummyxmpp&quot;</span><span class="p">,</span>
<span class="s2">&quot;xmppPasswd&quot;</span><span class="p">:</span> <span class="s2">&quot;X&quot;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>POST /api/1.2/servercheck</strong></p>
<blockquote>
<div><p>Post a server check result to the serverchecks table.</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="55%" />
<col width="20%" />
<col width="25%" />
</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>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">host_name</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">value</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;host_name&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;servercheck_short_name&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<blockquote>
<div><p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="15%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
<td>array</td>
<td>A collection of alert messages.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;level</span></code></td>
<td>string</td>
<td>Success, info, warning or error.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;text</span></code></td>
<td>string</td>
<td>Alert message.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">&quot;alerts&quot;</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;level&quot;</span><span class="p">:</span> <span class="s2">&quot;success&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s2">&quot;Server Check was successfully updated.&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>POST /api/1.2/servers</strong></p>
<blockquote>
<div><p>Allow user to create a server.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: admin or oper</p>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<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>hostName</td>
<td>yes</td>
<td>The host name part of the server.</td>
</tr>
<tr class="row-odd"><td>domainName</td>
<td>yes</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
<tr class="row-even"><td>cachegroup</td>
<td>yes</td>
<td>cache group name</td>
</tr>
<tr class="row-odd"><td>interfaceName</td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>ipAddress</td>
<td>yes</td>
<td>Must be unique per server profile.</td>
</tr>
<tr class="row-odd"><td>ipNetmask</td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>ipGateway</td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>interfaceMtu</td>
<td>no</td>
<td>1500 or 9000</td>
</tr>
<tr class="row-even"><td>physLocation</td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>type</td>
<td>yes</td>
<td>server type</td>
</tr>
<tr class="row-even"><td>profile</td>
<td>yes</td>
<td>Profile ID - Profile&#8217;s CDN must match server&#8217;s.</td>
</tr>
<tr class="row-odd"><td>cdnName</td>
<td>yes</td>
<td>cdn name the server belongs to</td>
</tr>
<tr class="row-even"><td>tcpPort</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>httpsPort</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>xmppId</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>xmppPasswd</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>ip6Address</td>
<td>no</td>
<td>Must be unique per server profile.</td>
</tr>
<tr class="row-odd"><td>ip6Gateway</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>rack</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>mgmtIpAddress</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>mgmtIpNetmask</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>mgmtIpGateway</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>iloIpAddress</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>iloIpNetmask</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>iloIpGateway</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>iloUsername</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>iloPassword</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>routerHostName</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>routerPortName</td>
<td>no</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">&quot;hostName&quot;</span><span class="p">:</span> <span class="s2">&quot;tc1_ats1&quot;</span><span class="p">,</span>
<span class="s2">&quot;domainName&quot;</span><span class="p">:</span> <span class="s2">&quot;my.test.com&quot;</span><span class="p">,</span>
<span class="s2">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s2">&quot;cache_group_edge&quot;</span><span class="p">,</span>
<span class="s2">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn_number_1&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceName&quot;</span><span class="p">:</span> <span class="s2">&quot;eth0&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;10.74.27.188&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipNetmask&quot;</span><span class="p">:</span> <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s2">&quot;ipGateway&quot;</span><span class="p">:</span> <span class="s2">&quot;10.74.27.1&quot;</span><span class="p">,</span>
<span class="s2">&quot;interfaceMtu&quot;</span><span class="p">:</span> <span class="s2">&quot;1500&quot;</span><span class="p">,</span>
<span class="s2">&quot;physLocation&quot;</span><span class="p">:</span> <span class="s2">&quot;plocation-chi-1&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE&quot;</span><span class="p">,</span>
<span class="s2">&quot;profile&quot;</span><span class="p">:</span> <span class="s2">&quot;EDGE1_CDN1_421&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<blockquote>
<div><p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="11%" />
<col width="67%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>hostName</td>
<td>string</td>
<td>The host name part of the server.</td>
</tr>
<tr class="row-odd"><td>Name</td>
<td>string</td>
<td>Description</td>
</tr>
<tr class="row-even"><td>domainName</td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
<tr class="row-odd"><td>cachegroup</td>
<td>string</td>
<td>cache group name</td>
</tr>
<tr class="row-even"><td>interfaceName</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>ipAddress</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>ipNetmask</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>ipGateway</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>interfaceMtu</td>
<td>string</td>
<td>1500 or 9000</td>
</tr>
<tr class="row-odd"><td>physLocation</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>type</td>
<td>string</td>
<td>server type</td>
</tr>
<tr class="row-odd"><td>profile</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>cdnName</td>
<td>string</td>
<td>cdn name the server belongs to</td>
</tr>
<tr class="row-odd"><td>tcpPort</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>httpsPort</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>xmppId</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>xmppPasswd</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>ip6Address</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>ip6Gateway</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>rack</td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>mgmtIpAddress</td>