resource_CloudCredentialsController.html 29.7 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: CloudCredentialsController</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: CloudCredentialsController</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
54
          <li><a href="#resource_CloudCredentialsController_postCredentials_POST"><abbr title="POST /user/v1.0/credentials/cloud/">POST /user/v1.0/credentials/cl...</abbr></a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
          <li><a href="#resource_CloudCredentialsController_deleteAll_DELETE"><abbr title="DELETE /user/v1.0/credentials/cloud/all">DELETE /user/v1.0/credentials/...</abbr></a></li>
          <li><a href="#resource_CloudCredentialsController_getIds_GET"><abbr title="GET /user/v1.0/credentials/cloud/ids">GET /user/v1.0/credentials/clo...</abbr></a></li>
          <li><a href="#resource_CloudCredentialsController_getSample_GET"><abbr title="GET /user/v1.0/credentials/cloud/sample">GET /user/v1.0/credentials/clo...</abbr></a></li>
          <li><a href="#resource_CloudCredentialsController_delete_DELETE"><abbr title="DELETE /user/v1.0/credentials/cloud/{id}">DELETE /user/v1.0/credentials/...</abbr></a></li>
          <li><a href="#resource_CloudCredentialsController_get_GET"><abbr title="GET /user/v1.0/credentials/cloud/{id}">GET /user/v1.0/credentials/clo...</abbr></a></li>
          <li><a href="#resource_CloudCredentialsController_addLogineKey_POST"><abbr title="POST /user/v1.0/credentials/cloud/upload/{id}">POST /user/v1.0/credentials/cl...</abbr></a></li>
          <li class="divider"></li>
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="resources.html">Resources</a></li>
          <li class="dropdown"><a href="resource_CloudCredentialsController.html">CloudCredentialsController</a></li>
        </ol>

      <h1 class="page-header">CloudCredentialsController <small>Resource</small></h1>

      <p>This controller is responsible for handling CloudCredentials.
CloudCredentials are a represntation of the credentials that are used by the
provisoner to request for resources (VMs)</p>

      <div id="resource_CloudCredentialsController_postCredentials_POST">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
80
        <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/credentials/cloud/ <a href="./user/v1.0/credentials/cloud/" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

        <p>Post the cloud credentials.</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-request-body">
          <caption>Request Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_CloudCredentials.html">CloudCredentials</a>
 (JSON)</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
116
            <td><span class="label label-warning response-code">404</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
            <td><span class="response-condition">Access key ID can't be empty</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">At least one key ID is posted</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
            <th>description</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
            <td rowspan="2" class="multi-row-description"><span class="response-description">the CloudCredentials id</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
160
POST /user/v1.0/credentials/cloud/
Spiros Koulouzis's avatar
Spiros Koulouzis committed
161 162 163 164 165
Content-Type: application/json
Accept: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
166 167
  &quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
  &quot;cloudProviderName&quot; : &quot;ec2&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
168
  &quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
169 170 171 172
  &quot;attributes&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
173
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
174
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
175
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
}
                </code>
              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_deleteAll_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
196
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/credentials/cloud/all <a href="./user/v1.0/credentials/cloud/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
197

Spiros Koulouzis's avatar
Spiros Koulouzis committed
198
        <p>Deletes all credentials. Use with caution !</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
214 215 216 217
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Credentiasl exist</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/credentials/cloud/all
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
261
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
262 263 264 265 266 267 268 269 270 271 272 273
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_getIds_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
274
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/credentials/cloud/ids <a href="./user/v1.0/credentials/cloud/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

        <p>Gets all the IDs of the stored cloud credentials</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
292 293 294 295
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Credentials exist</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
            <th>description</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of string
 (JSON)</span></td>
            <td rowspan="2" class="multi-row-description"><span class="response-description">a list of stored IDs</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/credentials/cloud/ids
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_getSample_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
354
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/credentials/cloud/sample <a href="./user/v1.0/credentials/cloud/sample" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

        <p></p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_CloudCredentials.html">CloudCredentials</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_cloudCredentials.html">cloudCredentials</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/credentials/cloud/sample
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
420 421
  &quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
  &quot;cloudProviderName&quot; : &quot;ec2&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
422
  &quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
423 424 425 426
  &quot;attributes&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
427
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
428
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
429
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
430 431 432 433 434 435 436 437 438
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_delete_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
439
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/credentials/cloud/{id} <a href="./user/v1.0/credentials/cloud/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

        <p>Delete the cloud credentials</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
455
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
456 457 458 459 460 461 462
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">the id of the cloud credentials</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
463
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
464 465 466 467 468 469 470 471 472 473 474 475 476
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
477 478 479 480
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Credential exists</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
            <th>description</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
            <td rowspan="2" class="multi-row-description"><span class="response-description">the id of the cloud credentials</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/credentials/cloud/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
526
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
527 528 529 530 531 532 533 534 535 536 537 538
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_get_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
539
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/credentials/cloud/{id} <a href="./user/v1.0/credentials/cloud/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

        <p>Get the cloud credentials</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
555
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
556 557 558 559 560 561 562
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">the id of the cloud credentials</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
563
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
564 565 566 567 568 569 570 571 572 573 574 575 576
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
577 578 579 580 581 582 583 584
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Credential not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Credential exists</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
            <th>description</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_CloudCredentials.html">CloudCredentials</a>
 (JSON)</span></td>
            <td rowspan="2" class="multi-row-description"><span class="response-description">the cloud credentials</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_cloudCredentials.html">cloudCredentials</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/credentials/cloud/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
635 636
  &quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
  &quot;cloudProviderName&quot; : &quot;ec2&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
637
  &quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
638 639 640 641
  &quot;attributes&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
642
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
643
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
644
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
645 646 647 648 649 650 651 652 653
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_CloudCredentialsController_addLogineKey_POST">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
654
        <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/credentials/cloud/upload/{id} <a href="./user/v1.0/credentials/cloud/upload/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

        <p>Upload the login keys for a cloud provider. The cloud credentials have to
be created</p>

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
671
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
672 673 674 675 676 677 678
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
679
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
680 681 682 683 684
          </tr>
          <tr>
            <td><span class="parameter-name">file</span></td>
            <td>query</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
685
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
686 687 688 689 690 691 692 693 694 695 696 697 698
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
699 700 701 702 703 704 705 706 707 708 709 710
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Credential not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">400</span></td>
            <td><span class="response-condition">Did not upload file</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Key added to credential</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
            <th>description</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
            <td rowspan="2" class="multi-row-description"><span class="response-description">the CloudCredentials id</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
POST /user/v1.0/credentials/cloud/upload/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
756
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>