http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/index.rst.txt b/docs/master/_sources/index.rst.txt index 50b604b..4f97825 100644 --- a/docs/master/_sources/index.rst.txt +++ b/docs/master/_sources/index.rst.txt @@ -60,6 +60,14 @@ A guide to the various internal and external APIs, and an introduction for the T development/index +APIs +==== +A guide to external RESTful APIs for Traffic Ops + +.. toctree:: + :maxdepth: 3 + + api/index FAQ ===
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/index.html ---------------------------------------------------------------------- diff --git a/docs/master/api/index.html b/docs/master/api/index.html new file mode 100644 index 0000000..d5f155e --- /dev/null +++ b/docs/master/api/index.html @@ -0,0 +1,369 @@ + + + + +<!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>APIs — Traffic Control 2.2-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="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> + <link rel="next" title="API Overview" href="traffic_ops_api.html"/> + <link rel="prev" title="Traffic Server" href="../development/traffic_server.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">APIs</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="routes.html">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li> + + <li>APIs</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/api/index.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="apis"> +<h1>APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h1> +<p>A guide to external RESTful APIs for Traffic Ops</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api.html">API Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#response-structure">Response Structure</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#api-errors">API Errors</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="routes.html">API Routes</a></li> +<li class="toctree-l1"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a><ul> +<li class="toctree-l2"><a class="reference internal" href="v11/asn.html">ASN</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/cachegroup.html">Cache Group</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/cdn.html">CDN</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/changelog.html">Change Logs</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/deliveryservice.html">Delivery Service</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/hwinfo.html">Hardware Info</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/parameter.html">Parameter</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/phys_location.html">Physical Location</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/profile.html">Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/region.html">Regions</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/role.html">Roles</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/server.html">Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/static_dns.html">Static DNS Entries</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/status.html">Status</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/system.html">System</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/to_extension.html">TO Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/type.html">Types</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/user.html">Users</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a><ul> +<li class="toctree-l2"><a class="reference internal" href="v12/api_capability.html">API-Capabilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/asn.html">ASN</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/cache.html">Cache</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/cachegroup.html">Cache Group</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/cachegroup_parameter.html">Cache Group parameters</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/cache_stats.html">Cache Statistics</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/capability.html">Capabilities</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/cdn.html">CDN</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/changelog.html">Change Logs</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/configfiles_ats.html">Config Files and Config File Metadata</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice.html">Delivery Service</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice_regex.html">Delivery Service Regexes</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice_stats.html">Delivery Service Statistics</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/division.html">Divisions</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/federation.html">Federation</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/federation_deliveryservice.html">Federation Delivery Service</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/federation_federationresolver.html">Federation Federation Resolver</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/federation_resolver.html">Federation Resolver</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/federation_user.html">Federation User</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/hwinfo.html">Hardware Info</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/iso.html">ISO</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/job.html">Jobs</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/parameter.html">Parameter</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/phys_location.html">Physical Location</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/profile.html">Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/profile_parameter.html">Profile parameters</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/influxdb.html">InfluxDB</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/region.html">Regions</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/role.html">Roles</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/server.html">Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/static_dns.html">Static DNS Entries</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/status.html">Status</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/steering_target.html">Steering Targets</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/system.html">System</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/tenant.html">Tenants</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/to_extension.html">TO Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/type.html">Types</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/user.html">Users</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/topology.html">Snapshot CRConfig</a></li> +</ul> +</li> +</ul> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/routes.html ---------------------------------------------------------------------- diff --git a/docs/master/api/routes.html b/docs/master/api/routes.html new file mode 100644 index 0000000..e1b77d1 --- /dev/null +++ b/docs/master/api/routes.html @@ -0,0 +1,468 @@ + + + + +<!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>API Routes — Traffic Control 2.2-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="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> + <link rel="up" title="APIs" href="index.html"/> + <link rel="next" title="API 1.1 Reference" href="v11/index.html"/> + <link rel="prev" title="API Overview" href="traffic_ops_api.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="index.html">APIs</a> »</li> + + <li>API Routes</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/api/routes.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="v11/index.html" class="btn btn-neutral float-right" title="API 1.1 Reference">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_ops_api.html" class="btn btn-neutral" title="API Overview"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <style> +table { + table-layout: fixed; + width: 100%; +} + +td { + word-wrap:break-word; +} +table.docutils col:nth-child(1) { + width: 30%; +} +table.docutils col:nth-child(2) { + width: 30%; +} +table.docutils col:nth-child(3) { + width: 30%; +} +.wy-nav-content { + max-width: 1200px; + width: 90%; +} +</style><div class="section" id="api-routes"> +<span id="to-api-routes"></span><h1>API Routes<a class="headerlink" href="#api-routes" title="Permalink to this headline">¶</a></h1> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="37%" /> +<col width="37%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">1.0</th> +<th class="head">1.1</th> +<th class="head">1.2</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>/asns</td> +<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td> +<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td> +</tr> +<tr class="row-odd"><td>/availableds</td> +<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td> +<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td> +</tr> +<tr class="row-even"><td><em>Not Implemented</em></td> +<td><em>Not Implemented</em></td> +<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td> +</tr> +<tr class="row-odd"><td>/datacrans</td> +<td>/api/1.1/crans.json</td> +<td>/api/1.2/crans.json</td> +</tr> +<tr class="row-even"><td>/datacrans/orderby/:field</td> +<td>/api/1.1/crans.json</td> +<td>/api/1.2/crans.json</td> +</tr> +<tr class="row-odd"><td>/datadeliveryservice</td> +<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td> +<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td> +</tr> +<tr class="row-even"><td>/datadeliveryserviceserver</td> +<td>/api/1.1/deliveryserviceserver.json</td> +<td>/api/1.2/deliveryserviceserver.json</td> +</tr> +<tr class="row-odd"><td>/datadomains</td> +<td>/api/1.1/cdns/domains.json</td> +<td>/api/1.2/cdns/domains.json</td> +</tr> +<tr class="row-even"><td><em>Not Implemented</em></td> +<td><em>Not Implemented</em></td> +<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td> +</tr> +<tr class="row-odd"><td>/datahwinfo</td> +<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td> +<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td> +</tr> +<tr class="row-even"><td>/datalinks</td> +<td>/api/1.1/deliveryserviceserver.json</td> +<td>/api/1.2/deliveryserviceserver.json</td> +</tr> +<tr class="row-odd"><td>/datalinks/orderby/:field</td> +<td>/api/1.1/deliveryserviceserver.json</td> +<td>/api/1.2/deliveryserviceserver.json</td> +</tr> +<tr class="row-even"><td>/datalogs</td> +<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td> +<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td> +</tr> +<tr class="row-odd"><td>/datalocation/orderby/id</td> +<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td> +<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td> +</tr> +<tr class="row-even"><td>/datalocationparameters</td> +<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td> +<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td> +</tr> +<tr class="row-odd"><td>/dataparameter</td> +<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td> +<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td> +</tr> +<tr class="row-even"><td>/dataparameter/:parameter</td> +<td>/api/1.1/parameters/profile/:parameter.json</td> +<td>/api/1.2/parameters/profile/:parameter.json</td> +</tr> +<tr class="row-odd"><td>/dataphys_location</td> +<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td> +<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td> +</tr> +<tr class="row-even"><td><p class="first">/dataprofile</p> +<p class="last">/dataprofile/orderby/name</p> +</td> +<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td> +<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td> +</tr> +<tr class="row-odd"><td>/dataregion</td> +<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td> +<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td> +</tr> +<tr class="row-even"><td>/datarole</td> +<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td> +<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td> +</tr> +<tr class="row-odd"><td>/datarole/orderby/:field</td> +<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td> +<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td> +</tr> +<tr class="row-even"><td>/dataserver</td> +<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td> +<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td> +</tr> +<tr class="row-odd"><td>/dataserver/orderby/:field</td> +<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td> +<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td> +</tr> +<tr class="row-even"><td>/dataserverdetail/select/:hostname</td> +<td>/api/1.1/servers/hostname/:hostname/details.json</td> +<td>/api/1.2/servers/hostname/:hostname/details.json</td> +</tr> +<tr class="row-odd"><td>/datastaticdnsentry</td> +<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td> +<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td> +</tr> +<tr class="row-even"><td>/datastatus</td> +<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td> +<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td> +</tr> +<tr class="row-odd"><td>/datastatus/orderby/name</td> +<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td> +<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td> +</tr> +<tr class="row-even"><td>/datatype</td> +<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td> +<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td> +</tr> +<tr class="row-odd"><td>/datatype/orderby/:field</td> +<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td> +<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td> +</tr> +<tr class="row-even"><td>/datauser</td> +<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td> +<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td> +</tr> +<tr class="row-odd"><td>/datauser/orderby/:field</td> +<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td> +<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td> +</tr> +<tr class="row-even"><td><em>Not Implemented</em></td> +<td><em>Not Implemented</em></td> +<td><a class="reference internal" href="v12/configfiles_ats.html#to-api-v12-configfiles-ats-route"><span class="std std-ref">/api/1.2/servers/:hostname/configfiles/ats</span></a></td> +</tr> +</tbody> +</table> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="v11/index.html" class="btn btn-neutral float-right" title="API 1.1 Reference">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_ops_api.html" class="btn btn-neutral" title="API Overview"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/traffic_ops_api.html ---------------------------------------------------------------------- diff --git a/docs/master/api/traffic_ops_api.html b/docs/master/api/traffic_ops_api.html new file mode 100644 index 0000000..09ae269 --- /dev/null +++ b/docs/master/api/traffic_ops_api.html @@ -0,0 +1,492 @@ + + + + +<!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>API Overview — Traffic Control 2.2-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="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> + <link rel="up" title="APIs" href="index.html"/> + <link rel="next" title="API Routes" href="routes.html"/> + <link rel="prev" title="APIs" href="index.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/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/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">APIs</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="routes.html">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="index.html">APIs</a> »</li> + + <li>API Overview</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/api/traffic_ops_api.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="api-overview"> +<h1>API Overview<a class="headerlink" href="#api-overview" title="Permalink to this headline">¶</a></h1> +<p>The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.</p> +<div class="section" id="response-structure"> +<h2>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">¶</a></h2> +<p>All successful responses have the following structure:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span> +<span class="p">}</span> +</pre></div> +</div> +<p>To make the documentation easier to read, only the <code class="docutils literal notranslate"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p> +</div> +<div class="section" id="using-api-endpoints"> +<h2>Using API Endpoints<a class="headerlink" href="#using-api-endpoints" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li>Authenticate with your Traffic Portal or Traffic Ops user account credentials.</li> +<li>Upon successful user authentication, note the mojolicious cookie value in the response headers.</li> +<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li> +</ol> +<p>Example:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json +{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]} +[jvd@laika ~]$ +[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login +* Hostname was NOT found in DNS cache +* Trying ::1... +* connect to ::1 port 3000 failed: Connection refused +* Trying 127.0.0.1... +* Connected to localhost (127.0.0.1) port 3000 (#0) +> POST /api/1.1/user/login HTTP/1.1 +> User-Agent: curl/7.37.1 +> Host: localhost:3000 +> Accept: application/json +> Content-Length: 32 +> Content-Type: application/x-www-form-urlencoded +> +* upload completely sent off: 32 out of 32 bytes +< HTTP/1.1 200 OK +< Connection: keep-alive +< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE +< Access-Control-Allow-Origin: http://localhost:8080 +< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept +< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly +< Content-Type: application/json +< Date: Sat, 18 Apr 2015 20:10:01 GMT +< Access-Control-Allow-Credentials: true +< Content-Length: 81 +< Cache-Control: no-cache, no-store, max-age=0, must-revalidate +* Server Mojolicious (Perl) is not blacklisted +< Server: Mojolicious (Perl) +< +* Connection #0 to host localhost left intact +{"alerts":[{"level":"success","text":"Successfully logged in."}]} +[jvd@laika ~]$ + +[jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json +{"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,} +[jvd@laika ~]$ +</pre></div> +</div> +</div> +<div class="section" id="api-errors"> +<h2>API Errors<a class="headerlink" href="#api-errors" title="Permalink to this headline">¶</a></h2> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +</tbody> +</table> +<p>The 3 most common errors returned by Traffic Ops are:</p> +<dl class="docutils"> +<dt>401 Unauthorized</dt> +<dd><p class="first">When you donât supply the right cookie, this is the response.</p> +<div class="last highlight-default notranslate"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json +* Hostname was NOT found in DNS cache +* Trying ::1... +* connect to ::1 port 3000 failed: Connection refused +* Trying 127.0.0.1... +* Connected to localhost (127.0.0.1) port 3000 (#0) +> GET /api/1.1/usage/asns.json HTTP/1.1 +> User-Agent: curl/7.37.1 +> Host: localhost:3000 +> Accept: application/json +> +< HTTP/1.1 401 Unauthorized +< Cache-Control: no-cache, no-store, max-age=0, must-revalidate +< Content-Length: 84 +* Server Mojolicious (Perl) is not blacklisted +< Server: Mojolicious (Perl) +< Connection: keep-alive +< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE +< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept +< Access-Control-Allow-Origin: http://localhost:8080 +< Date: Sat, 18 Apr 2015 20:36:12 GMT +< Content-Type: application/json +< Access-Control-Allow-Credentials: true +< +* Connection #0 to host localhost left intact +{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]} +[jvd@laika ~]$ +</pre></div> +</div> +</dd> +<dt>404 Not Found</dt> +<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p> +<div class="last highlight-default notranslate"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json +* Hostname was NOT found in DNS cache +* Trying ::1... +* connect to ::1 port 3000 failed: Connection refused +* Trying 127.0.0.1... +* Connected to localhost (127.0.0.1) port 3000 (#0) +> GET /api/1.1/asnsjj.json HTTP/1.1 +> User-Agent: curl/7.37.1 +> Host: localhost:3000 +> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; +> Accept: application/json +> +< HTTP/1.1 404 Not Found +* Server Mojolicious (Perl) is not blacklisted +< Server: Mojolicious (Perl) +< Content-Length: 75 +< Cache-Control: no-cache, no-store, max-age=0, must-revalidate +< Content-Type: application/json +< Date: Sat, 18 Apr 2015 20:37:43 GMT +< Access-Control-Allow-Credentials: true +< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly +< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE +< Connection: keep-alive +< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept +< Access-Control-Allow-Origin: http://localhost:8080 +< +* Connection #0 to host localhost left intact +{"alerts":[{"text":"Resource not found.","level":"error"}]} +[jvd@laika ~]$ +</pre></div> +</div> +</dd> +<dt>500 Internal Server Error</dt> +<dd><p class="first">When you are asking for a correct path, but the database doesnât match, it returns a 500:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json +* Hostname was NOT found in DNS cache +* Trying ::1... +* connect to ::1 port 3000 failed: Connection refused +* Trying 127.0.0.1... +* Connected to localhost (127.0.0.1) port 3000 (#0) +> GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1 +> User-Agent: curl/7.37.1 +> Host: localhost:3000 +> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; +> Accept: application/json +> +< HTTP/1.1 500 Internal Server Error +* Server Mojolicious (Perl) is not blacklisted +< Server: Mojolicious (Perl) +< Cache-Control: no-cache, no-store, max-age=0, must-revalidate +< Content-Length: 93 +< Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly +< Content-Type: application/json +< Date: Sat, 18 Apr 2015 20:45:06 GMT +< Access-Control-Allow-Credentials: true +< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE +< Connection: keep-alive +< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept +< Access-Control-Allow-Origin: http://localhost:8080 +< +* Connection #0 to host localhost left intact +{"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]} +[jvd@laika ~]$ +</pre></div> +</div> +<p class="last">The rest of the API documentation will only document the <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> case, where no errors have occured.</p> +</dd> +</dl> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v11/asn.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v11/asn.html b/docs/master/api/v11/asn.html new file mode 100644 index 0000000..2c8923b --- /dev/null +++ b/docs/master/api/v11/asn.html @@ -0,0 +1,364 @@ + + + + +<!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>ASN — Traffic Control 2.2-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="index" title="Index" + href="../../genindex.html"/> + <link rel="search" title="Search" href="../../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/> + <link rel="up" title="API 1.1 Reference" href="index.html"/> + <link rel="next" title="Cache Group" href="cachegroup.html"/> + <link rel="prev" title="API 1.1 Reference" href="index.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/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/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li><a href="index.html">API 1.1 Reference</a> »</li> + + <li>ASN</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v11/asn.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.1 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="asn"> +<span id="to-api-v11-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-1-asns"> +<span id="to-api-v11-asns-route"></span><h2>/api/1.1/asns<a class="headerlink" href="#api-1-1-asns" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.1/asns</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</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 notranslate"><span class="pre">asns</span></code></td> +<td>array</td> +<td>A collection of asns</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td> +<td>string</td> +<td>Local unique identifier for the ASN</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>asn</span></code></td> +<td>string</td> +<td>Autonomous System Numbers per APNIC for identifying a service provider.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cachegroup</span></code></td> +<td>string</td> +<td>Related cachegroup name</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"asns"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">},</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.1 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file