blob: 94f13bffbd618128b571499ac1dbddfee9b6333f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../includes/main.css" type="text/css">
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon">
<title>Apache CloudStack | The Power Behind Your Cloud</title>
</head>
<body>
<div id="insidetopbg">
<div id="inside_wrapper">
<div class="uppermenu_panel">
<div class="uppermenu_box"></div>
</div>
<div id="main_master">
<div id="inside_header">
<div class="header_top">
<a class="cloud_logo" href="http://cloudstack.org"></a>
<div class="mainemenu_panel"></div>
</div>
</div>
<div id="main_content">
<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<div class="api_titlebox">
<div class="api_titlebox_left">
<span>
Apache CloudStack v4.1.0 Root Admin API Reference
</span>
<p></p>
<h1>addS3</h1>
<p>Adds S3</p>
</div>
<div class="api_titlebox_right">
<a class="api_backbutton" href="../TOC_Root_Admin.html"></a>
</div>
</div>
<div class="api_tablepanel">
<h2>Request parameters</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td>
</tr>
<tr>
<td style="width:200px;"><strong>accesskey</strong></td><td style="width:500px;"><strong>S3 access key</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>bucket</strong></td><td style="width:500px;"><strong>name of the template storage bucket</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>secretkey</strong></td><td style="width:500px;"><strong>S3 secret key</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><i>connectiontimeout</i></td><td style="width:500px;"><i>connection timeout (milliseconds)</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>endpoint</i></td><td style="width:500px;"><i>S3 host name</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>maxerrorretry</i></td><td style="width:500px;"><i>maximum number of times to retry on error</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>sockettimeout</i></td><td style="width:500px;"><i>socket timeout (milliseconds)</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>usehttps</i></td><td style="width:500px;"><i>connect to the S3 endpoint via HTTPS?</i></td><td style="width:180px;"><i>false</i></td>
</tr>
</table>
</div>
<div class="api_tablepanel">
<h2>Response Tags</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">The ID of the S3 configuration</td>
</tr>
<tr>
<td style="width:200px;"><strong>accesskey</strong></td><td style="width:500px;">The S3 access key</td>
</tr>
<tr>
<td style="width:200px;"><strong>bucket</strong></td><td style="width:500px;">The name of the template storage bucket</td>
</tr>
<tr>
<td style="width:200px;"><strong>connectiontimeout</strong></td><td style="width:500px;">The connection timeout (milliseconds)</td>
</tr>
<tr>
<td style="width:200px;"><strong>endpoint</strong></td><td style="width:500px;">The S3 end point</td>
</tr>
<tr>
<td style="width:200px;"><strong>maxerrorretry</strong></td><td style="width:500px;">The maximum number of time to retry a connection on error.</td>
</tr>
<tr>
<td style="width:200px;"><strong>secretkey</strong></td><td style="width:500px;">The S3 secret key</td>
</tr>
<tr>
<td style="width:200px;"><strong>sockettimeout</strong></td><td style="width:500px;">The connection socket (milliseconds)</td>
</tr>
<tr>
<td style="width:200px;"><strong>usehttps</strong></td><td style="width:500px;">Connect to S3 using HTTPS?</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer_mainmaster">
<p>Copyright &copy; 2012 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
<br>
Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
</div>
</div>
</div>
</div>
</body>
</html>