<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API">Asterisk 12 Endpoints REST API</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~dlee">David M. Lee</a>
</h4>
<br/>
<div class="notificationGreySide">
<div>
<ul>
<li><a href='#Asterisk12EndpointsRESTAPI-Endpoints'>Endpoints</a></li>
<ul>
<li><a href='#Asterisk12EndpointsRESTAPI-GET%2Fendpoints'>GET /endpoints</a></li>
<ul>
<li><a href='#Asterisk12EndpointsRESTAPI-Queryparameters'>Query parameters</a></li>
</ul>
<li><a href='#Asterisk12EndpointsRESTAPI-GET%2Fendpoints%2F%5C'>GET /endpoints/{endpointId}</a></li>
<ul>
<li><a href='#Asterisk12EndpointsRESTAPI-Pathparameters'>Path parameters</a></li>
</ul>
</ul>
</ul></div>
<h1><a name="Asterisk12EndpointsRESTAPI-Endpoints"></a>Endpoints</h1>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Method </th>
<th class='confluenceTh'> Path </th>
<th class='confluenceTh'> Return Model </th>
<th class='confluenceTh'> Summary </th>
</tr>
<tr>
<td class='confluenceTd'> GET </td>
<td class='confluenceTd'> <a href="#Asterisk12EndpointsRESTAPI-getEndpoints">/endpoints</a> </td>
<td class='confluenceTd'> List[Endpoint] </td>
<td class='confluenceTd'> List available endoints </td>
</tr>
<tr>
<td class='confluenceTd'> GET </td>
<td class='confluenceTd'> <a href="#Asterisk12EndpointsRESTAPI-getEndpoint">/endpoints/{endpointId}</a> </td>
<td class='confluenceTd'> Endpoint </td>
<td class='confluenceTd'> Details for an endpoint </td>
</tr>
</tbody></table>
</div>
<p><a name="Asterisk12EndpointsRESTAPI-getEndpoints"></a></p>
<h2><a name="Asterisk12EndpointsRESTAPI-GET%2Fendpoints"></a>GET /endpoints</h2>
<p>List available endoints</p>
<h3><a name="Asterisk12EndpointsRESTAPI-Queryparameters"></a>Query parameters</h3>
<ul>
<li>withType: string- Filter endpoints by type (sip,iax2,dhadi,...)</li>
</ul>
<p><a name="Asterisk12EndpointsRESTAPI-getEndpoint"></a></p>
<h2><a name="Asterisk12EndpointsRESTAPI-GET%2Fendpoints%2F%5C"></a>GET /endpoints/{endpointId}</h2>
<p>Details for an endpoint</p>
<h3><a name="Asterisk12EndpointsRESTAPI-Pathparameters"></a>Path parameters</h3>
<ul>
<li>endpointId: string- ID of the endpoint</li>
</ul>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>