| |
| |
| <!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>TO Extensions — Traffic Control 1.1.3 documentation </title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> |
| |
| |
| |
| <link rel="top" title="Traffic Control 1.1.3 documentation" href="../../index.html"/> |
| <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> |
| <link rel="next" title="Types" href="type.html"/> |
| <link rel="prev" title="System" href="system.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.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_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_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.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> |
| </ul> |
| </li> |
| </ul> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Traffic Control</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../index.html">Traffic Control 1.1.3</a> »</li> |
| |
| <li><a href="../index.html">Developer’s Guide</a> »</li> |
| |
| <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> |
| |
| <li>TO Extensions</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../_sources/development/traffic_ops_rest/to_extension.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="to-extensions"> |
| <span id="to-api-ext"></span><h1>TO Extensions<a class="headerlink" href="#to-extensions" title="Permalink to this headline">¶</a></h1> |
| <p><strong>GET /api/1.1/to_extensions.json</strong></p> |
| <p>Retrieves the list of extensions.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Response Content Type: application/json</p> |
| <p><strong>Return Values</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="33%" /> |
| <col width="10%" /> |
| <col width="56%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">script_file</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">info_url</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">additional_config_json</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">isactive</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-python"><div class="highlight"><pre>{ |
| “response”: [ |
| { |
| script_file: "ping", |
| version: "1.0.0", |
| name: "ILO_PING", |
| description: null, |
| info_url: "http://foo.com/bar.html", |
| additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }", |
| isactive: "1", |
| id: "1", |
| type: "CHECK_EXTENSION_BOOL", |
| servercheck_short_name: "ILO" |
| }, |
| { |
| script_file: "ping", |
| version: "1.0.0", |
| name: "10G_PING", |
| description: null, |
| info_url: "http://foo.com/bar.html", |
| additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }", |
| isactive: "1", |
| id: "2", |
| type: "CHECK_EXTENSION_BOOL", |
| servercheck_short_name: "10G" |
| } |
| ], |
| “version”: "1.1" |
| } |
| </pre></div> |
| </div> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.1/to_extensions</strong></p> |
| <blockquote> |
| <div><p>Creates a Traffic Ops extension.</p> |
| <p>Authentication Required: Yes</p> |
| <p><strong>Request Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="33%" /> |
| <col width="10%" /> |
| <col width="56%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">info_url</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">script_file</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">isactive</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">additional_config_json</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-python"><div class="highlight"><pre>{ |
| "name": "ILO_PING", |
| "version": "1.0.0", |
| "info_url": "http://foo.com/bar.html", |
| "script_file": "ping", |
| "isactive": "1", |
| "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}", |
| "description": null, |
| "servercheck_short_name": "ILO" |
| "type": "CHECK_EXTENSION_BOOL", |
| } |
| </pre></div> |
| </div> |
| <p>Response Content Type: application/json</p> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="15%" /> |
| <col width="63%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> |
| <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> |
| <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.1/to_extensions/:id/delete</strong></p> |
| <blockquote> |
| <div><p>Deletes a Traffic Ops extension.</p> |
| <p>Authentication Required: Yes</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="23%" /> |
| <col width="29%" /> |
| <col width="49%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>yes</td> |
| <td>TO extension id</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Response Content Type: application/json</p> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="15%" /> |
| <col width="63%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-python"><div class="highlight"><pre> { |
| "alerts": [ |
| { |
| "level": "success", |
| "text": "Extension deleted." |
| } |
| ], |
| "version": "1.1" |
| } |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../', |
| VERSION:'1.1.3', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true |
| }; |
| </script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |