Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (60 sloc) 2.03 KB
<h1>7.1 HTTP API</h1>
<p>
The EventQL HTTP API gives you full access to EventQL via HTTP. All EventQL
operations can be executed via this API. The EventQL CLI uses the HTTP API to
access EventQL.
</p>
<h4>Version Prefix</h4>
<p>All API routes are prefixed with <code>/api/v1/</code>. This documentation
is only for the v1 version of the API</p>
<p class="warning">
<strong>Backwards compatibility:</strong> At the current version, EventQL does not yet
promise backwards compatibility even with the v1 prefix. We'll remove this warning
when this policy changes. We expect we'll reach API stability by EventQL 1.0.
</p>
<h3>Tables</h3>
<table class="api_reference http">
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/create">/api/v1/tables/create</a></td>
<td>Create a new table (or overwrite an existing table).</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/add_field">/api/v1/tables/add_field</a></td>
<td>Add a field to an existing table.</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/remove_field">/api/v1/tables/remove_field</a></td>
<td>Remove a field from an existing table.</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/insert">/api/v1/tables/insert</a></td>
<td>Insert or update row(s).</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/drop">/api/v1/tables/drop</a></td>
<td>Remove an existing table.</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/list">/api/v1/tables/list</a></td>
<td>List existing tables.</td>
</tr>
<tr>
<td><span class="tag">POST</span></td>
<td><a href="tables/describe">/api/v1/tables/describe</a></td>
<td>Obtain information about the table and its columns.</td>
</tr>
</table>
<h3>SQL</h3>
<table class="api_reference http">
<tr>
<td><span class="tag">POST/GET</span></td>
<td><a href="sql">/api/v1/sql</a></td>
<td>Execute SQL</td>
</tr>
</table>