<!doctype html>
<html>
<head>
<title>REST API</title>
<link rel="stylesheet" href="styles/site.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="styles/icons.css" type="text/css">
<script src="js/jquery.min.js"></script>
<script src="tree/collapsibleTreeMenu.js"></script>
<link href="tree/collapsibleTreeMenu.css" rel="stylesheet" type="text/css">
</head>
<body class="theme-default aui-theme-default">
<div id="page">
<div id="main" class="aui-page-panel">
<div id="main-header">
<div id="breadcrumb-section">
<ol id="breadcrumbs">
<li> <span><a href="Rhapsody-Integration-Engine-6.5_133160975.html">Rhapsody Integration Engine 6.5</a></span> </li>
<li> <span><a href="Developing-Rhapsody_133161055.html">Developing Rhapsody</a></span> </li>
<li> <span><a href="Remote-Monitoring-and-Administration_133161056.html">Remote Monitoring and Administration</a></span> </li>
</ol>
</div>
<h1 id="title-heading" class="pagetitle"> <span id="title-text">REST API</span> </h1>
</div>
<div id="content" class="view">
<div id="main-content" class="wiki-content group">
<p>The Rhapsody Integration Engine (Rhapsody) provides a REST API which enables users to monitor the status of and perform limited management tasks on a large number of Rhapsody engines remotely through other applications (for example, third-party web-based tools, command-line tools, mobile applications):</p>
<div class="table-wrap">
<table class="wrapped confluenceTable">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="confluenceTd"><p><a href="Authentication_133161147.html">Authentication</a></p></td>
<td class="confluenceTd"><p>REST API authenticates using basic HTTP authentication over an encrypted HTTPS connection.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Authorization_133161145.html">Authorization</a></p></td>
<td class="confluenceTd"><p>Sets permissions required to call particular methods of the REST API.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Session-Management_133161151.html">Session Management</a></p></td>
<td class="confluenceTd"><p>Tracks active sessions and purges timed-out sessions.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Auditing-Calls_133161144.html">Auditing Calls</a></p></td>
<td class="confluenceTd"><p>Requests made via the REST API are audited using Rhapsody's auditing functionality.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Request-and-Response-Formats_133161143.html#RequestandResponseFormats-CrossSiteRequestForgeryProtection">Cross Site Request Forgery Protection</a></p></td>
<td class="confluenceTd"><p>All <code>PUT</code>/<code>POST</code>/<code>DELETE</code> operations that do not establish a new session must include the CSRF toke, otherwise they are rejected.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Excessive-Calls_133161141.html">Excessive Calls</a></p></td>
<td class="confluenceTd"><p>Protecting the Rhapsody engine from far too many REST API calls within a short period of time.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><a href="Monitoring-REST-API-Methods_133161062.html">Monitoring REST API Methods</a></p></td>
<td class="confluenceTd">
<div class="content-wrapper">
<p>Expose the following <a href="Management-Console_133163667.html">Management Console</a> functionality:</p>
<p></p>
<ul class="childpages-macro">
<li><a href="Alerts_133161102.html">Alerts</a></li>
<li><a href="Archive-Cleanup-Management_133161089.html">Archive Cleanup Management</a></li>
<li><a href="Backup-Schedules_133161098.html">Backup Schedules</a></li>
<li><a href="Basic-Information_133161091.html">Basic Information</a></li>
<li><a href="Components-Monitoring_133161092.html">Components Monitoring</a></li>
<li><a href="Engine-Statistics_133161096.html">Engine Statistics</a></li>
<li><a href="Error-and-Hold-Queue-Monitoring_133161090.html">Error and Hold Queue Monitoring</a></li>
<li><a href="Lookup-Tables-Monitoring_133161097.html">Lookup Tables Monitoring</a></li>
<li><a href="Message-Retrieval_133161101.html">Message Retrieval</a></li>
<li><a href="Message-Searches_133161099.html">Message Searches</a></li>
<li><a href="Transient-State-Monitoring_133161088.html">Transient State Monitoring</a></li>
<li><a href="133161087.html">Management Console's General Settings</a></li>
<li><a href="Logs_133167964.html">Logs</a></li>
<li><a href="Product-Usage-Settings_133308383.html">Product Usage Settings</a></li>
<li><a href="Filter-Testing_133168932.html">Filter Testing</a></li>
</ul>
<p></p>
</div></td>
</tr>
<tr>
<td colspan="1" class="confluenceTd"><a href="Administration-REST-API-Methods_133161103.html">Administration REST API Methods</a></td>
<td colspan="1" class="confluenceTd">
<div class="content-wrapper">
<p>Expose the following administrative functionality:</p>
<p></p>
<ul class="childpages-macro">
<li><a href="Configuration-Administration_133161134.html">Configuration Administration</a></li>
<li><a href="Custom-Modules-and-Libraries_133161136.html">Custom Modules and Libraries</a></li>
<li><a href="License-Administration_133161131.html">License Administration</a></li>
<li><a href="Lookup-Tables-Administration_133161132.html">Lookup Tables Administration</a></li>
<li><a href="Security-Objects-Administration_133161137.html">Security Objects Administration</a></li>
<li><a href="Users-and-Access-Groups-Administration_133161130.html">Users and Access Groups Administration</a></li>
<li><a href="Variables-Administration_133161133.html">Variables Administration</a></li>
<li><a href="Web-Service-User-Store-Administration_133161138.html">Web Service User Store Administration</a></li>
<li><a href="Engine-Administration_133161139.html">Engine Administration</a></li>
<li><a href="Templates-Administration_133161129.html">Templates Administration</a></li>
</ul>
<p></p>
</div></td>
</tr>
<tr>
<td colspan="1" class="confluenceTd"><a href="REST-API-Versions_133161142.html">REST API Versions</a></td>
<td colspan="1" class="confluenceTd">Provides backwards compatibility of REST API methods.</td>
</tr>
</tbody>
</table>
</div>
<p> </p>
</div>
</div>
</div>
</div>
</body>
</html>