| |
| |
| |
| |
| <!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 Stats" href="../development/traffic_stats.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_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> |
| </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> |
| <li class="toctree-l2"><a class="reference internal" href="v13/index.html">API 1.3 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_stats.html" class="btn btn-neutral" title="Traffic Stats"><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> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</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/cachegroup_fallbacks.html">Cache Group Fallback</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> |
| <li class="toctree-l1"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="v13/coordinate.html">Coordinate</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="v13/origin.html">Origin</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_stats.html" class="btn btn-neutral" title="Traffic Stats"><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> |