5022 lines
107 KiB
HTML
5022 lines
107 KiB
HTML
|
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>alert - Documentation</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"></script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"></script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||
|
|
<label for="nav-trigger" class="navicon-button x">
|
||
|
|
<div class="navicon"></div>
|
||
|
|
</label>
|
||
|
|
|
||
|
|
<label for="nav-trigger" class="overlay"></label>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Actions.html">Actions</a><ul class='methods'><li data-type='method'><a href="Actions.html#triggerAction">triggerAction</a></li><li data-type='method'><a href="Actions.html#triggerPM2Action">triggerPM2Action</a></li><li data-type='method'><a href="Actions.html#triggerScopedAction">triggerScopedAction</a></li></ul></li><li><a href="Auth.html">Auth</a><ul class='methods'><li data-type='method'><a href="Auth.html#register">register</a></li><li data-type='method'><a href="Auth.html#revoke">revoke</a></li></ul></li><li><a href="Bucket.html">Bucket</a><ul class='methods'><li data-type='method'><a href="Bucket.html#claimTrial">claimTrial</a></li><li data-type='method'><a href="Bucket.html#destroy">destroy</a></li><li data-type='method'><a href="Bucket.html#removeInvitation">removeInvitation</a></li><li data-type='method'><a href="Bucket.html#removeUser">removeUser</a></li><li data-type='method'><a href="Bucket.html#retrieveCharges">retrieveCharges</a></li><li data-type='method'><a href="Bucket.html#sendFeedback">sendFeedback</a></li><li data-type='method'><a href="Bucket.html#setNotificationState">setNotificationState</a></li><li data-type='method'><a href="Bucket.html#setUserRole">setUserRole</a></li><li data-type='method'><a href="Bucket.html#transferOwnership">transferOwnership</a></li><li data-type='method'><a href="Bucket.html#update">update</a></li><li data-type='method'><a href="Bucket.html#updateUserOptions">updateUserOptions</a></li></ul></li><li><a href="Bucket.alert.html">alert</a><ul class='methods'><li data-type='method'><a href="Bucket.alert.html#create">create</a></li><li data-type='method'><a href="Bucket.alert.html#delete">delete</a></li><li data-type='method'><a href="Bucket.alert.html#deleteEvent">deleteEvent</a></li><li data-type='method'><a href="Bucket.alert.html#get">get</a></li><li data-type='method'><a href="Bucket.alert.html#list">list</a></li><li data-type='method'><a href="Bucket.alert.html#sendReport">sendReport</a></li><li data-type='method'><a href="Bucket.alert.html#triggerSample">triggerSample</a></li><li data-type='method'><a href="Bucket.alert.html#update">update</a></li><li data-type='method'><a href="Bucket.alert.html#updateAlert">updateAlert</a></li><li data-type='method'><a href="Bucket.alert.html#updateSlack">updateSlack</a></li><li data-type='method'><a href="Bucket.alert.html#updateWebhooks">updateWebhooks</a></li></ul></li><li><a href="Bucket.alert.analyzer.html">analyzer</a><ul class='methods'><li data-type='method'><a href="Bucket.alert.analyzer.html#editState">editState</a></li><li data-type='method'><a href="Bucket.alert.analyzer.html#list">list</a></li><li data-type='method'><a href="Bucket.alert.analyzer.html#updateConfig">updateConfig</a></li></ul></li><li><a href="Bucket.application.html">application</a><ul class='methods'><li data-type='method'><a href="Bucket.application.html#create">create</a></li><li data-type='method'><a href="Bucket.application.html#delete">delete</a></li><li data-type='method'><a href="Bucket.application.html#get">get</a></li><li data-type='method'><a href="Bucket.application.html#getPreview">getPreview</a></li><li data-type='method'><a href="Bucket.application.html#getReports">getReports</a></li><li data-type='method'><a href="Bucket.application.html#list">list</a></li><li data-type='method'><a href="Bucket.application.html#update">update</a></li></ul></li><li><a href="Bucket.billing.html">billing</a><ul class='methods'><li data-type='method'><a href="Bucket.billing.html#attachBankAccount">attachBankAccount</a></li><li data-type='method'><a href="Bucket.billing.html#attachCreditCard">attachCreditCard</a></li><li data-type='method'><a href="Bucket.billing.html#deleteBankAccount">deleteBankAccount</a></li><li data-type='method'><a href="Bucket.billing.html#deleteCreditCard">deleteCreditCard</a></li><li data-type='method'><a href="Bucket.billing.html#fetchBankAccount">fetchBankAccount</a></li><li data-type='method'><a href="Bucket.billing.html#fetchCreditCard">fetchCreditCard</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">alert</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<span class="ancestors"><a href="Bucket.html">Bucket</a>.</span>
|
||
|
|
|
||
|
|
alert
|
||
|
|
</h2>
|
||
|
|
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Namespaces</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><a href="Bucket.alert.analyzer.html">analyzer</a></dt>
|
||
|
|
<dd></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="create"><span class="type-signature">(route) </span>create<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Create a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">name</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Alert name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">enabled</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert's state</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `metric`, `event` or `webcheck`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">initiator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Should be metric name or event name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.operator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `>`, `<`, `=`, `>=` or `<=`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.threshold</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Value to reach to send an alert</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.act</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `always`, `opposite`, `first` or `diff`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.timerange</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Timerange to check, in seconds</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.apps</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with apps name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.servers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with servers name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.initiators</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with initiators name (need to be set if no apps or servers)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.sources</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with sources name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">List of actions to trigger</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Type of action</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].params</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Params for action</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing parameters</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly created alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="delete"><span class="type-signature">(route) </span>delete<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">DELETE</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Delete a custom alert
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">204</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly deleted alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteEvent"><span class="type-signature"></span>deleteEvent<span class="signature">()</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Not used anymore</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="get"><span class="type-signature">(async, route) </span>get<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">GET</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Get a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly returned alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="list"><span class="type-signature">(route) </span>list<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">GET</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
List all custom alerts
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">list all alerts</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="sendReport"><span class="type-signature"></span>sendReport<span class="signature">()</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Not used anymore</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="triggerSample"><span class="type-signature">(route) </span>triggerSample<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert/sample</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Send an alert sample via slack/webhook or mail
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">202</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly sended alert actions</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="update"><span class="type-signature">(route) </span>update<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/update</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update alert settings
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">triggers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">triggers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">new triggers object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateAlert"><span class="type-signature">(route) </span>updateAlert<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">PUT</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">name</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">enabled</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert's state</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `metric`, `event` or `webcheck`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">initiator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be metric name or event name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.operator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `>`, `<`, `=`, `<=` or `>=`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.threshold</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Value to reach to send an alert</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.act</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `always`, `opposite`, `first` or `diff`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.timerange</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Timerange to check, in seconds</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.apps</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with apps name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.servers</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with servers name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.initiators</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with initiators name (need to be set if no apps or servers)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.sources</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with sources name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">List of actions to trigger</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Type of action</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].params</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Params for action</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing parameters</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly created alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateSlack"><span class="type-signature">(route) </span>updateSlack<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/updateSlack</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update slack webhook
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">slack</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">slack.active</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">slack.url</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">needed if active is set to true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">bucket</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateWebhooks"><span class="type-signature">(route) </span>updateWebhooks<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/updateWebhooks</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update webhooks
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">webhooks</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">webhooks.active</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">webhooks.url</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">needed if active is set to true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">bucket</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<span class="ancestors"><a href="Bucket.html">Bucket</a>.</span>
|
||
|
|
|
||
|
|
alert
|
||
|
|
</h2>
|
||
|
|
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Namespaces</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><a href="Bucket.alert.analyzer.html">analyzer</a></dt>
|
||
|
|
<dd></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="create"><span class="type-signature">(route) </span>create<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Create a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">name</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Alert name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">enabled</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert's state</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `metric`, `event` or `webcheck`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">initiator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">Should be metric name or event name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.operator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `>`, `<`, `=`, `>=` or `<=`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.threshold</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Value to reach to send an alert</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.act</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `always`, `opposite`, `first` or `diff`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.timerange</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Timerange to check, in seconds</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.apps</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with apps name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.servers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with servers name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.initiators</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with initiators name (need to be set if no apps or servers)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.sources</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with sources name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last">List of actions to trigger</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Type of action</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].params</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Params for action</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing parameters</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly created alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="delete"><span class="type-signature">(route) </span>delete<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">DELETE</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Delete a custom alert
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">204</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly deleted alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteEvent"><span class="type-signature"></span>deleteEvent<span class="signature">()</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Not used anymore</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="get"><span class="type-signature">(async, route) </span>get<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">GET</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Get a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly returned alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="list"><span class="type-signature">(route) </span>list<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">GET</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
List all custom alerts
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">list all alerts</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="sendReport"><span class="type-signature"></span>sendReport<span class="signature">()</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Not used anymore</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="triggerSample"><span class="type-signature">(route) </span>triggerSample<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert/sample</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Send an alert sample via slack/webhook or mail
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">202</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly sended alert actions</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="update"><span class="type-signature">(route) </span>update<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/update</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update alert settings
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">triggers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">triggers</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">new triggers object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateAlert"><span class="type-signature">(route) </span>updateAlert<span class="signature">(:id, :alert)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">PUT</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/:alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update a custom alert
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">name</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">enabled</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Alert's state</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `metric`, `event` or `webcheck`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">initiator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be metric name or event name</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.operator</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `>`, `<`, `=`, `<=` or `>=`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.threshold</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Value to reach to send an alert</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.act</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Should be `always`, `opposite`, `first` or `diff`</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">options.timerange</td>
|
||
|
|
<td class="type">Number</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Timerange to check, in seconds</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.apps</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with apps name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.servers</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with servers name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.initiators</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with initiators name (need to be set if no apps or servers)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">scope.sources</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Array of strings with sources name (can be empty)</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions</td>
|
||
|
|
<td class="type">Array</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">List of actions to trigger</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].type</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Type of action</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">actions[].params</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">Params for action</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">:alert</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing parameters</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">404</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert not found</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">successfuly created alert</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:alert</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">alert id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateSlack"><span class="type-signature">(route) </span>updateSlack<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/updateSlack</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update slack webhook
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">slack</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">slack.active</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">slack.url</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">needed if active is set to true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">bucket</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateWebhooks"><span class="type-signature">(route) </span>updateWebhooks<span class="signature">(:id)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<h5>Route:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead><tr><th>Method</th><th class="last">Path</th></tr></thead>
|
||
|
|
<tr>
|
||
|
|
<td class="type">POST</td>
|
||
|
|
<td class="name last">/api/bucket/:id/alerts/updateWebhooks</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
Update webhooks
|
||
|
|
<h5>Authentication</h5>
|
||
|
|
<p>A authentication is needed to access this endpoint</p>
|
||
|
|
<h5>Body Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">webhooks</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
<td class="attributes"></td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">webhooks.active</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td class="name">webhooks.url</td>
|
||
|
|
<td class="type">Boolean</td>
|
||
|
|
<td class="attributes">optional</td>
|
||
|
|
|
||
|
|
<td class="description last">needed if active is set to true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Header Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">Authorization</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bearer access token issued for the user</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Route Parameters:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">:id</td>
|
||
|
|
<td class="type">String</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
<td class="name">bucket</td>
|
||
|
|
<td class="type">Object</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h5>Response Code:</h5>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="type">500</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">database error</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">400</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">missing triggers parameter</td>
|
||
|
|
</tr><tr>
|
||
|
|
|
||
|
|
<td class="type">200</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">succesfully update triggers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>:id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">bucket id</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 13 2019 12:24:19 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script>prettyPrint();</script>
|
||
|
|
<script src="scripts/linenumber.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|