%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Bucket - 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></li><li data-type='method'><a href="Bucket.billing.html#fetchCreditCards">fetchCreditCards</a></li><li data-type='method'><a href="Bucket.billing.html#fetchDefaultCreditCard">fetchDefaultCreditCard</a></li><li data-type='method'><a href="Bucket.billing.html#fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="Bucket.billing.html#getInvoices">getInvoices</a></li><li data-type='method'><a href="Bucket.billing.html#getReceipts">getReceipts</a></li><li data-type='method'><a href="Bucket.billing.html#getSubcription">getSubcription</a></li><li data-type='method'><a href="Bucket.billing.html#getSubcriptionState">getSubcriptionState</a></li><li data-type='method'><a href="Bucket.billing.html#paymentIntentSucceed">paymentIntentSucceed</a></li><li data-type='method'><a href="Bucket.billing.html#setDefaultCard">setDefaultCard</a></li><li data-type='method'><a href="Bucket.billing.html#startTrial">startTrial</a></li><li data-type='method'><a href="Bucket.billing.html#subscribe">subscribe</a></li><li data-type='method'><a href="Bucket.billing.html#updateCreditCard">updateCreditCard</a></li><li data-type='method'><a href="Bucket.billing.html#updateMetadata">updateMetadata</a></li></ul></li><li><a href="Bucket.server.html">server</a><ul class='methods'><li data-type='method'><a href="Bucket.server.html#deleteServer">deleteServer</a></li></ul></li><li><a href="Bucket.webcheck.html">webcheck</a><ul class='methods'><li data-type='method'><a href="Bucket.webcheck.html#create">create</a></li><li data-type='method'><a href="Bucket.webcheck.html#delete">delete</a></li><li data-type='method'><a href="Bucket.webcheck.html#get">get</a></li><li data-type='method'><a href="Bucket.webcheck.html#getMetrics">getMetrics</a></li><li data-type='method'><a href="Bucket.webcheck.html#list">list</a></li><li data-type='method'><a href="Bucket.webcheck.html#listMetrics">listMetrics</a></li><li data-type='method'><a href="Bucket.webcheck.html#listRegions">listRegions</a></li><li data-type='method'><a href="Bucket.webcheck.html#update">update</a></li></ul></li><li><a href="Dashboard.html">Dashboard</a><ul class='methods'><li data-type='method'><a href="Dashboard.html#create">create</a></li><li data-type='method'><a href="Dashboard.html#remove">remove</a></li><li data-type='method'><a href="Dashboard.html#retrieve">retrieve</a></li><li data-type='method'><a href="Dashboard.html#retrieveAll">retrieveAll</a></li><li data-type='method'><a href="Dashboard.html#update">update</a></li></ul></li><li><a href="Data.dependencies.html">dependencies</a><ul class='methods'><li data-type='method'><a href="Data.dependencies.html#retrieve">retrieve</a></li></ul></li><li><a href="Data.events.html">events</a><ul class='methods'><li data-type='method'><a href="Data.events.html#deleteAll">deleteAll</a></li><li data-type='method'><a href="Data.events.html#retrieve">retrieve</a></li><li data-type='method'><a href="Data.events.html#retrieveHistogram">retrieveHistogram</a></li><li data-type='method'><a href="Data.events.html#retrieveMetadatas">retrieveMetadatas</a></li></ul></li><li><a href="Data.issues.html">issues</a><ul class='methods'><li data-type='method'><a href="Data.issues.html#delete">delete</a></li><li data-type='method'><a href="Data.issues.html#deleteAll">deleteAll</a></li><li data-type='method'><a href="Data.issues.html#findOccurences">findOccurences</a></li><li data-type='method'><a href="Data.issues.html#getReplay">getReplay</a></li><li data-type='method'><a href="Data.issues.html#list">list</a></li><li data-type='method'><a href="Data.issues.html#listOccurencesForIdentifier">listOccurencesForIdentifier</a></li><li data-type='method'><a href="Data.issues.html#retrieveHistogram">retrieveHistogram</a></li><li data-type='method'><a href="Data.issues.html#search">search</a></li><li data-type='method'><a href="Data.issues.html#summary">summary</a></li></ul></li><li><a href="Data.logs.html">logs</a><ul class='methods'><li data-type='method'><a href="Data.logs.html#retrieve">retrieve</a></li><li data-type='method'><a href="Data.logs.html#retrieveHistogram">retrieveHistogram</a></li></ul></li><li><a href="Data.metrics.html">metrics</a><ul class='methods'><li data-type='method'><a href="Data.metrics.html#retrieveAggregations">retrieveAggregations</a></li><li data-type='method'><a href="Data.metrics.html#retrieveHistogram">retrieveHistogram</a></li><li data-type='method'><a href="Data.metrics.html#retrieveList">retrieveList</a></li><li data-type='method'><a href="Data.metrics.html#retrieveMetadatas">retrieveMetadatas</a></li></ul></li><li><a href="Data.notifications.html">notifications</a><ul class='methods'><li data-type='method'><a href="Data.notifications.html#list">list</a></li><li data-type='method'><a href="Data.notifications.html#retrieve">retrieve</a></li></ul></li><li><a href="Data.outliers.html">outliers</a><ul class='methods'><li data-type='method'><a href="Data.outliers.html#retrieve">retrieve</a></li></ul></li><li><a href="Data.processes.html">processes</a><ul class='methods'><li data-type='method'><a href="Data.processes.html#retrieveDeployments">retrieveDeployments</a></li><li data-type='method'><a href="Data.processes.html#retrieveEvents">retrieveEvents</a></li></ul></li><li><a href="Data.profiling.html">profiling</a><ul class='methods'><li data-type='method'><a href="Data.profiling.html#delete">delete</a></li><li data-type='method'><a href="Data.profiling.html#download">download</a></li><li data-type='method'><a href="Data.profiling.html#list">list</a></li><li data-type='method'><a href="Data.profiling.html#retrieve">retrieve</a></li></ul></li><li><a href="Data.status.html">status</a><ul class='methods'><li data-type='method'><a href="Data.status.html#retrieve">retrieve</a></li><li data-type='method'><a href="Data.status.html#retrieveBlacklisted">retrieveBlacklisted</a></li></ul></li><li><a href="Data.traces.html">traces</a><ul class='methods'><li data-type='method'><a href="Data.traces.html#getDurationAvg">getDurationAvg</a></li><li data-type='method'><a href="Data.traces.html#getHistogramByTag">getHistogramByTag</a></li><li data-type='method'><a href="Data.traces.html#getServices">getServices</a></li><li data-type='method'><a href="Data.traces.html#getTags">getTags</a></li><li data-type='method'><a href="Data.traces.html#getTagsValue">getTagsValue</a></li><li data-type='method'><a href="Data.traces.html#list">list</a></li><li data-type='method'><a href="Data.traces.html#retrieve">retrieve</a></li></ul></li><li><a href="Data.transactions.html">transactions</a><ul class='methods'><li data-type='method'><a href="Data.transactions.html#delete">delete</a></li><li data-type='method'><a href="Data.transactions.html#retrieveHistogram">retrieveHistogram</a></li><li data-type='method'><a href="Data.transactions.html#retrieveSummary">retrieveSummary</a></li></ul></li><li><a href="Misc.html">Misc</a><ul class='methods'><li data-type='method'><a href="Misc.html#listChangelogArticles">listChangelogArticles</a></li><li data-type='method'><a href="Misc.html#retrieveCompany">retrieveCompany</a></li><li data-type='method'><a href="Misc.html#retrieveCoupon">retrieveCoupon</a></li><li data-type='method'><a href="Misc.html#retrieveNodeRelease">retrieveNodeRelease</a></li><li data-type='method'><a href="Misc.html#retrievePlans">retrievePlans</a></li><li data-type='method'><a href="Misc.html#retrievePM2Version">retrievePM2Version</a></li><li data-type='method'><a href="Misc.html#retrieveVAT">retrieveVAT</a></li></ul></li><li><a href="Node.html">Node</a><ul class='methods'><li data-type='method'><a href="Node.html#getDefaultNode">getDefaultNode</a></li></ul></li><li><a href="Orchestration.html">Orchestration</a><ul class='methods'><li data-type='method'><a href="Orchestration.html#selfSend">selfSend</a></li></ul></li><li><a href="Tokens.html">Tokens</a><ul class='methods'><li data-type='method'><a href="Tokens.html#create">create</a></li><li data-type='method'><a href="Tokens.html#remove">remove</a></li><li data-type='method'><a href="Tokens.html#retrieve">retrieve</a></li></ul></li><li><a href="User.html">User</a><ul class='methods'><li data-type='method'><a href="User.html#attachCreditCard">attachCreditCard</a></li><li data-type='method'><a href="User.html#delete">delete</a></li><li data-type='method'><a href="User.html#deleteCreditCard">deleteCreditCard</a></li><li data-type='method'><a href="User.html#fetchCreditCard">fetchCreditCard</a></li><li data-type='method'><a href="User.html#fetchDefaultCreditCard">fetchDefaultCreditCard</a></li><li data-type='method'><a href="User.html#fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="User.html#listCharges">listCharges</a></li><li data-type='method'><a href="User.html#listSubscriptions">listSubscriptions</a></li><li data-type='method'><a href="User.html#setDefaultCard">setDefaultCard</a></li><li data-type='method'><a href="User.html#show">show</a></li><li data-type='method'><a href="User.html#update">update</a></li><li data-type='method'><a href="User.html#updateCreditCard">updateCreditCard</a></li><li data-type='method'><a href="User.html#updateMetadata">updateMetadata</a></li></ul></li><li><a href="User.otp.html">otp</a><ul class='methods'><li data-type='method'><a href="User.otp.html#disable">disable</a></li><li data-type='method'><a href="User.otp.html#enable">enable</a></li><li data-type='method'><a href="User.otp.html#retrieve">retrieve</a></li></ul></li><li><a href="User.providers.html">providers</a><ul class='methods'><li data-type='method'><a href="User.providers.html#add">add</a></li><li data-type='method'><a href="User.providers.html#remove">remove</a></li><li data-type='method'><a href="User.providers.html#retrieve">retrieve</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#setupServer">setupServer</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Bucket</h1>
<section>
<header>
<h2>
Bucket
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Namespaces</h3>
<dl>
<dt><a href="Bucket.alert.html">alert</a></dt>
<dd></dd>
<dt><a href="Bucket.alert.html">alert</a></dt>
<dd></dd>
<dt><a href="Bucket.application.html">application</a></dt>
<dd></dd>
<dt><a href="Bucket.billing.html">billing</a></dt>
<dd></dd>
<dt><a href="Bucket.server.html">server</a></dt>
<dd></dd>
<dt><a href="Bucket.webcheck.html">webcheck</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="create"><span class="type-signature">(route) </span>create<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/create_classic</td>
</tr>
</table>
Create a bucket
<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">the name of the bucket</td>
</tr><tr>
<td class="name">comment</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last">any comments that will be written under the bucket name</td>
</tr><tr>
<td class="name">app_url</td>
<td class="type">String</td>
<td class="attributes">optional</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>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">the created bucket</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">400</td>
<td class="description last">missing parameters</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">you cant create any more bucket</td>
</tr><tr>
<td class="type">500</td>
<td class="description last">database error</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully created a bucket</td>
</tr>
</table>
</div>
<h4 class="name" id="currentRole"><span class="type-signature">(route) </span>currentRole<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/current_role</td>
</tr>
</table>
Retrieve the role of the user
<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>
</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">role</td>
<td class="type">String</td>
<td class="description last">the user role</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">200</td>
<td class="description last">succesfully retrieved the use role</td>
</tr>
</table>
</div>
<h4 class="name" id="getSubscription"><span class="type-signature">(route) </span>getSubscription<span class="type-signature"></span></h4>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
</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/subscription</td>
</tr>
</table>
Retrieve the subscription for the bucket
<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>
</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">.</td>
<td class="type">Object</td>
<td class="description last">subscription 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">404</td>
<td class="description last">the bucket doesnt have any subscription</td>
</tr><tr>
<td class="type">500</td>
<td class="description last">database error</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully retrieved the subscription</td>
</tr>
</table>
</div>
<h4 class="name" id="inviteUser"><span class="type-signature">(route) </span>inviteUser<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/add_user</td>
</tr>
</table>
Invite a specific user into the bucket
<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">email</td>
<td class="type">String</td>
<td class="description last">the email of the user</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">invitations</td>
<td class="type">Array</td>
<td class="description last">the list of invitations actually active</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">400</td>
<td class="description last">missing/invalid parameters</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">you cant invit more users because you hit the bucket limit</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully invited the user (either directly or by email)</td>
</tr>
</table>
</div>
<h4 class="name" id="retrieve"><span class="type-signature">(route) </span>retrieve<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</td>
</tr>
</table>
Retrieve bucket metadata
<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>
</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">.</td>
<td class="type">Object</td>
<td class="description last">bucket 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">200</td>
<td class="description last">succesfully retrieved the bucket</td>
</tr>
</table>
</div>
<h4 class="name" id="retrieveAll"><span class="type-signature">(route) </span>retrieveAll<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/</td>
</tr>
</table>
Retrieve the bucket of which the user is the member
<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>Response:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tr>
<td class="name">.</td>
<td class="type">Array</td>
<td class="description last">array of buckets</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">succesfully fetched bucket</td>
</tr>
</table>
</div>
<h4 class="name" id="retrieveServers"><span class="type-signature">(route) </span>retrieveServers<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/meta_servers</td>
</tr>
</table>
Retrieve metadata about the servers connected to this bucket
<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>
</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">.</td>
<td class="type">Array</td>
<td class="description last">servers metadata</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">succesfully retrieved the server's metadata</td>
</tr>
</table>
</div>
<h4 class="name" id="retrieveUsers"><span class="type-signature">(route) </span>retrieveUsers<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/users_authorized</td>
</tr>
</table>
Retrieve bucket's members
<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>
</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">.</td>
<td class="type">Array</td>
<td class="description last">a array of user containing their email, username and roles</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">succesfully retrieved bucket's members</td>
</tr>
</table>
</div>
<h4 class="name" id="upgrade"><span class="type-signature">(route) </span>upgrade<span class="type-signature"></span></h4>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
</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/upgrade</td>
</tr>
</table>
Upgrade bucket to a plan
<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">plan</td>
<td class="type">String</td>
<td class="attributes"></td>
<td class="description last">name of the plan to upgrade to</td>
</tr><tr>
<td class="name">stripe_token</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last">a card token created by stripe</td>
</tr><tr>
<td class="name">coupon_id</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last">the id of the stripe coupon</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">the bucket object</td>
</tr><tr>
<td class="name">subscription</td>
<td class="type">Object</td>
<td class="description last">the subscription object attached to the subscription</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">400</td>
<td class="description last">missing/invalid parameters</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">need a credit card OR not allowed to subscribe to the plan</td>
</tr><tr>
<td class="type">500</td>
<td class="description last">stripe/database error</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully upgraded</td>
</tr>
</table>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="claimTrial"><span class="type-signature">(route) </span>claimTrial<span class="signature">(:id)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
</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/start_trial</td>
</tr>
</table>
Launch a trial for the bucket
<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>
</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">duration</td>
<td class="type">String</td>
<td class="description last">the duration of the trial</td>
</tr><tr>
<td class="name">plan</td>
<td class="type">String</td>
<td class="description last">the plan of the trial</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">400</td>
<td class="description last">can't claim trial</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">trial launched</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="destroy"><span class="type-signature">(route) </span>destroy<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">DELETE</td>
<td class="name last">/api/bucket/:id</td>
</tr>
</table>
Delete a bucket
<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>
</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">.</td>
<td class="type">Object</td>
<td class="description last">the deleted bucket</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">succesfully deleted the bucket</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="removeInvitation"><span class="type-signature">(route) </span>removeInvitation<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">DELETE</td>
<td class="name last">/api/bucket/:id/invitation</td>
</tr>
</table>
Remove a invitation for a user
<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>Query 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">email</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last">the email of the invitation you want to delete</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">invitations</td>
<td class="type">Array</td>
<td class="description last">the list of invitations actually active</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">400</td>
<td class="description last">invalid/missing parameters</td>
</tr><tr>
<td class="type">500</td>
<td class="description last">database error</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully deleted the invitation</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="removeUser"><span class="type-signature">(route) </span>removeUser<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/remove_user</td>
</tr>
</table>
Remove a user from a bucket
<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">email</td>
<td class="type">String</td>
<td class="description last">the email of the user you want to remove</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">.</td>
<td class="type">Array</td>
<td class="description last">a array of user containing their email, username and roles</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">400</td>
<td class="description last">missing/invalid parameters</td>
</tr><tr>
<td class="type">404</td>
<td class="description last">user not found</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">impossible to remove the owner from the bucket</td>
</tr><tr>
<td class="type">500</td>
<td class="description last">database error</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="retrieveCharges"><span class="type-signature">(route) </span>retrieveCharges<span class="signature">(:id)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
</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/payment/charges</td>
</tr>
</table>
Retrieve the invoices for a given bucket
<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>
</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">.</td>
<td class="type">Array</td>
<td class="description last">array of invoices</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">400</td>
<td class="description last">Missing/invalid parameters</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully transfered the bucket, old owner is now admin</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="sendFeedback"><span class="type-signature">(route) </span>sendFeedback<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">PUT</td>
<td class="name last">/api/bucket/:id/feedback</td>
</tr>
</table>
Send feedback about keymetrics
<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">feedback</td>
<td class="type">String</td>
<td class="description last">the feedback text</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">feedback</td>
<td class="type">String</td>
<td class="description last">the feedback that hasn't been registered</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 feedback field</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully registered the feedback</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="setNotificationState"><span class="type-signature">(route) </span>setNotificationState<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/manage_notif</td>
</tr>
</table>
Set the notification state for a specific user
<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">email</td>
<td class="type">String</td>
<td class="description last">the user email</td>
</tr><tr>
<td class="name">state</td>
<td class="type">String</td>
<td class="description last">the notification state you want to set for that user
(either 'email' or 'nonde)</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">.</td>
<td class="type">Array</td>
<td class="description last">array of state for each user</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">user not found</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="setUserRole"><span class="type-signature">(route) </span>setUserRole<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/promote_user</td>
</tr>
</table>
Set the role of a specific user
<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">email</td>
<td class="type">String</td>
<td class="description last">the email of the user you want to change the role</td>
</tr><tr>
<td class="name">role</td>
<td class="type">String</td>
<td class="description last">the role you want to set</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">.</td>
<td class="type">Array</td>
<td class="description last">a array of user containing their email, username and roles</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">400</td>
<td class="description last">invalid/missing parameters</td>
</tr><tr>
<td class="type">404</td>
<td class="description last">user not found</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">impossible to set the role of the owner</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="transferOwnership"><span class="type-signature">(route) </span>transferOwnership<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/transfer_ownership</td>
</tr>
</table>
Transfer the ownership of a bucket
<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">new_owner</td>
<td class="type">String</td>
<td class="description last">the wanted owner's email</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">.</td>
<td class="type">Object</td>
<td class="description last">bucket 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">400</td>
<td class="description last">Missing/invalid parameters</td>
</tr><tr>
<td class="type">404</td>
<td class="description last">user not found</td>
</tr><tr>
<td class="type">403</td>
<td class="description last">the new owner need to have a active credit card</td>
</tr><tr>
<td class="type">200</td>
<td class="description last">succesfully transfered the bucket, old owner is now admin</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="update"><span class="type-signature">(async, 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">PUT</td>
<td class="name last">/api/bucket/:id</td>
</tr>
</table>
Update informations for the bucket
<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"></td>
</tr><tr>
<td class="name">comment</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last"></td>
</tr><tr>
<td class="name">app_url</td>
<td class="type">String</td>
<td class="attributes">optional</td>
<td class="description last"></td>
</tr><tr>
<td class="name">configuration</td>
<td class="type">String</td>
<td class="attributes">optional</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">.</td>
<td class="type">Object</td>
<td class="description last">bucket 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 parameters</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="updateUserOptions"><span class="type-signature">(route) </span>updateUserOptions<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">PUT</td>
<td class="name last">/api/bucket/:id/user_options</td>
</tr>
</table>
Update user options
<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">options</td>
<td class="type">Object</td>
<td class="description last">user options</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">200</td>
<td class="description last">succesfully update user options</td>
</tr><tr>
<td class="type">400</td>
<td class="description last">missing parameters</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>
Zerion Mini Shell 1.0