CINXE.COM

<!DOCTYPE html> <!DOCTYPE html> <head>  <script>(function (w, d, s, l, i) { w[l] = w[l] || []; w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f); })(window, document, 'script', 'dataLayer', 'GTM-PPZPQ6');</script>  <title>Introduction to F5 BIG-IP APIs</title> <meta charset="utf-8">  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">  <meta name="title" content="Introduction to F5 BIG-IP APIs" /> <meta name="product" content="" /> <meta name="version" content="" /> <meta name="updated_date" content="2024-09-11 02:54:39" /> <meta name="archived" content="Archived documents excluded" /> <meta name="doc_type" content="Manual" /> <meta name="lifecycle" content="release" /> <meta name="" content="" /> <link href="https://cdn.f5.com/favicon.ico" rel="icon"> </head> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Introduction to F5 BIG-IP APIs — 0.9.1</title> <link rel="stylesheet" href="_static/css/bootstrap.min.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/copybutton.css" /> <link rel="stylesheet" type="text/css" href="_static/table_styling.css" /> <link rel="stylesheet" type="text/css" href="/assets/css/bootstrap.min.css" /> <link rel="stylesheet" type="text/css" href="/assets/css/f5.css" /> <link rel="stylesheet" type="text/css" href="/assets/css/f5-theme.css" /> <link rel="stylesheet" type="text/css" href="/assets/css/custom.css" /> <link rel="stylesheet" type="text/css" href="/assets/css/CoveoFullSearch.css" /> <link rel="stylesheet" type="text/css" href="https://use.fontawesome.com/releases/v5.8.1/css/all.css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script> <script type="text/javascript" src="_static/clipboard.min.js"></script> <script type="text/javascript" src="_static/copybutton.js"></script> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="iApps Home" href="iapps/index.html" /> </head><body> <div id="clouddocs-header"></div> <div id="dismiss"> <button type="button" class="btn btn-info navbar-btn site-hidden"> <i class="fa fa-align-justify"></i> </button> </div> <div id="sidebar" class="section-nav">  <div id="version_selector_wrapper"> </div> <nav class="nav-sidebartoc"> <h5> 0.9.1 </h5>  <hr> <span class="nav-sidebartoc"> <ul> <li class="toctree-l1"><a class="reference internal" href="iapps/index.html">iApps Home</a></li> <li class="toctree-l1"><a class="reference internal" href="icontrol-rest/index.html">iControlREST Home</a></li> <li class="toctree-l1"><a class="reference internal" href="icontrol-soap/index.html">iControl (SOAP) Home</a></li> <li class="toctree-l1"><a class="reference internal" href="irules/index.html">iRules Home</a></li> <li class="toctree-l1"><a class="reference internal" href="irules-lx/index.html">iRulesLX Home</a></li> <li class="toctree-l1"><a class="reference internal" href="tmsh/index.html">TMSH Home</a></li> </ul> </span><!DOCTYPE html>  <hr> <span class="nav-sidebartoc">  </span> </nav> </div>         <div class="main active" id="content" > <article class="docs-container site-article-inner"> <!DOCTYPE html> <nav class="site-breadcrumb-nav site-nav"> <ul class="site-breadcrumb-list"> <li class="breadcrumb-item"><button type="button" id="sidebarCollapse" class="btn btn-info navbar-btn site-hidden"><i class="fa fa-align-justify"></i></button>&#x20 <a href="/">Clouddocs</a> > <a href="#"> </a> > Introduction to F5 BIG-IP APIs</li> </ul> </nav> <div class="sidebar" id="version-warning" style="display: none;"> <p class="first sidebar-title"> <span class="icon fa fa-info-circle fa-lg"></span> Version notice:</p> <p class="last" id="currentVersion"></p> </div> <div class="section" id="introduction-to-f5-big-ip-apis"> <span id="api-home"></span><h1>Introduction to F5 BIG-IP APIs<a class="headerlink" href="#introduction-to-f5-big-ip-apis" title="Permalink to this headline">¶</a></h1> <p>The F5 BIG-IP offers many programmable interfaces, from control-plane to data-plane. The documentation in this section focuses on these areas:</p> <ul class="simple"> <li><a class="reference external" href="iapps/">iApps</a> - customizable template driven configuration tools that allow you to deploy an application service as a single object</li> <li><a class="reference external" href="icontrol-rest/">iControlREST</a> - REST-based API for imperative configuration and service control of BIG-IP from remote applications</li> <li><a class="reference external" href="icontrol-soap/">iControl (SOAP)</a> - SOAP-based API for imperative configuration and service control of BIG-IP from remote applications</li> <li><a class="reference external" href="ihealth/">iHealth</a> - REST-based API for working progammatically with the <a class="reference external" href="https://ihealth.f5.com">F5 iHealth</a> diagnostics site.</li> <li><a class="reference external" href="irules/">iRules</a> - A Tcl-based event-driven programming API for manipulating data-plane traffic in real time.</li> <li><a class="reference external" href="irules-lx/">iRulesLX</a> - A Node.js-based event-driven programming API for manipulating data-plane traffic in real time.</li> <li><a class="reference external" href="tmsh/">tmsh (scripting)</a> - A Tcl-based scripting environment within the traffic management shell that supports control-plane actions. Deploying as iCall scripts unlocks event-driven actions as well.</li> </ul> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="iapps/index.html">iApps Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="iapps/AppSvcsiApp_overview.html">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="iapps/AppSvcsiApp_userguide_userguide.html">User Guide</a></li> <li class="toctree-l2"><a class="reference internal" href="iapps/AppSvcsiApp_refguide.html">Reference Guide</a></li> <li class="toctree-l2"><a class="reference internal" href="iapps/AppSvcsiApp_cla_landing.html">F5 Networks Contributor License Agreement</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="icontrol-rest/index.html">iControlREST Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_analytics.html">APIRef_tm_analytics</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_apm.html">APIRef_tm_apm</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_auth.html">APIRef_tm_auth</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_cli.html">APIRef_tm_cli</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_cm.html">APIRef_tm_cm</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_gtm.html">APIRef_tm_gtm</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_ilx.html">APIRef_tm_ilx</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_ltm.html">APIRef_tm_ltm</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_net.html">APIRef_tm_net</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_pem.html">APIRef_tm_pem</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_security.html">APIRef_tm_security</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_sys.html">APIRef_tm_sys</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_util.html">APIRef_tm_util</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_vcmp.html">APIRef_tm_vcmp</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_wam.html">APIRef_tm_wam</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-rest/APIRef_tm_wom.html">APIRef_tm_wom</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="icontrol-soap/index.html">iControl (SOAP) Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Common.html">Common</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/ARX.html">ARX</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/ASM.html">ASM</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Classification.html">Classification</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/GlobalLB.html">GlobalLB</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/iCall.html">iCall - test</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/LTConfig.html">LTConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/LocalLB.html">LocalLB</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Log.html">Log</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Management.html">Management</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Networking.html">Networking</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/PEM.html">PEM</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/Security.html">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/System.html">System</a></li> <li class="toctree-l2"><a class="reference internal" href="icontrol-soap/WebAccelerator.html">WebAccelerator</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="irules/index.html">iRules Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="irules/BIGIP_Commands_by_Version.html">BIG-IP Commands and Events by Version</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/Global.html">GLOBAL</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/AAA.html">AAA</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ACCESS.html">ACCESS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ACL.html">ACL</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ADAPT.html">ADAPT</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ADM.html">ADM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/AES.html">AES</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ANTIFRAUD.html">ANTIFRAUD</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/APM.html">APM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ASM.html">ASM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ASN1.html">ASN1</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/AUTH.html">AUTH</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/AVR.html">AVR</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/BOTDEFENSE.html">BOTDEFENSE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/BWC.html">BWC</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CACHE.html">CACHE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CATEGORY.html">CATEGORY</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CLASSIFICATION.html">CLASSIFICATION</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CLASSIFY.html">CLASSIFY</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/COMPRESS.html">COMPRESS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CONNECTOR.html">CONNECTOR</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/CRYPTO.html">CRYPTO</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DATAGRAM.html">DATAGRAM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DHCP.html">DHCP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DIAMETER.html">DIAMETER</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DNS.html">DNS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DNSMSG.html">DNSMSG</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/DOSL7.html">DOSL7</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ECA.html">ECA</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/FIX.html">FIX</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/FLOW.html">FLOW</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/FLOWTABLE.html">FLOWTABLE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/FTP.html">FTP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/GENERICMESSAGE.html">GENERICMESSAGE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/GTM.html">GTM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/GTP.html">GTP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/HSL.html">High Speed Logging</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/HTML.html">HTML</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/HTTP.html">HTTP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/HTTP2.html">HTTP2</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ICAP.html">ICAP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/IKE.html">IKE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ILX.html">ILX</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/IMAP.html">IMAP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/IP.html">IP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/IPFIX.html">IPFIX</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ISESSION.html">ISESSION</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ISTATS.html">iStats</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/IVS.html">IVS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/L7CHECK.html">L7CHECK</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/LB.html">LB</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/LINK.html">LINK</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/LSN.html">LSN</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/MESSAGE.html">MESSAGE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/MQTT.html">MQTT</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/MR.html">MR</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/NAME.html">NAME – Deprecated</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/NSH.html">NSH</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/NTLM.html">NTLM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ONECONNECT.html">ONECONNECT</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/PCP.html">PCP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/PEM.html">PEM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/POLICY.html">POLICY</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/POP3.html">POP3</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/PROFILE.html">PROFILE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/PSC.html">PSC</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/QOE.html">QOE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/RADIUS.html">RADIUS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/RESOLVER.html">RESOLVER</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/REWRITE.html">REWRITE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/ROUTE.html">ROUTE</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/RTSP.html">RTSP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SCTP.html">SCTP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SDP.html">SDP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SIDEBAND.html">SIDEBAND</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SIP.html">SIP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SIPALG.html">SIPALG</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SMTPS.html">SMTPS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SOCKS.html">SOCKS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/SSL.html">SSL</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/STATS.html">STATS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/STREAM.html">STREAM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/TAP.html">TAP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/TCP.html">TCP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/TMM.html">TMM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/UDP.html">UDP</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/URI.html">URI</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/VDI.html">VDI</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/WAM.html">WAM</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/WEBSSO.html">WEBSSO</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/WS.html">WS</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/X509.html">X509</a></li> <li class="toctree-l2"><a class="reference internal" href="irules/XLAT.html">XLAT</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="irules-lx/index.html">iRulesLX Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="irules-lx/APIReference.html">API Reference</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/APIReference.html#f5-nodejs">f5-nodejs</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXBufferUtil.html">ILXBufferUtil</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXDatagroup.html">ILXDatagroup</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXFlow.html">ILXFlow</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXHttpRequest.html">ILXHttpRequest</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXLbOptions.html">ILXLbOptions</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXLogger.html">ILXLogger</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXPlugin.html">ILXPlugin</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXPluginOptions.html">ILXPluginOptions</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXServer.html">ILXServer</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXStream.html">ILXStream</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXTable.html">ILXTable</a></li> <li class="toctree-l2"><a class="reference internal" href="irules-lx/ILXTransaction.html">ILXTransaction</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tmsh/index.html">TMSH Home</a><ul> <li class="toctree-l2"><a class="reference internal" href="tmsh/ConfigStatus.html">TMSH Configuration & Status Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="tmsh/TransactionControl.html">TMSH Transaction Control Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="tmsh/Logging.html">TMSH Logging Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="tmsh/Utility.html">TMSH Utility Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="tmsh/Help.html">TMSH Help Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="tmsh/Other.html">Other TMSH Commands</a></li> </ul> </li> </ul> </div> <p><em>The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.</em></p> </div> <div class="row next-prev-btn-row"> <div class="col-lg-12"> <a href="iapps/index.html" title="iApps Home" accesskey="n" class="btn btn-primary right">Next <i class="fa fa-arrow-circle-right" aria-hidden="true"></i></a> </div> </div> </article> </div> </div> <div id="clouddocs-footer"></div>   <script src="_static/js/index.js"></script> <script src="/assets/js/bootstrap.min.js"></script> <script src="/assets/js/clouddocs.js"></script> <script src="/assets/js/CoveoJsSearch.Lazy.min.js"></script> </body> </html>