| <!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>Ranger REST API: XKeyREST</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/enunciate.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">Ranger REST API: XKeyREST</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> |
| </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"> |
| <li><a href="#resource_XKeyREST_createKey_POST"><abbr title="POST /keys/key"><span class="sideoverflow">POST /keys/key</span></abbr></a></li> |
| <li><a href="#resource_XKeyREST_rolloverKey_PUT"><abbr title="PUT /keys/key"><span class="sideoverflow">PUT /keys/key</span></abbr></a></li> |
| <li><a href="#resource_XKeyREST_searchKeys_GET"><abbr title="GET /keys/keys"><span class="sideoverflow">GET /keys/keys</span></abbr></a></li> |
| <li><a href="#resource_XKeyREST_deleteKey_DELETE"><abbr title="DELETE /keys/key/{alias}"><span class="sideoverflow">DELETE /keys/key/{alias}</span></abbr></a></li> |
| <li><a href="#resource_XKeyREST_getKey_GET"><abbr title="GET /keys/key/{alias}"><span class="sideoverflow">GET /keys/key/{alias}</span></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_XKeyREST.html">XKeyREST</a></li> |
| </ol> |
| |
| <h1 class="page-header">XKeyREST <small>Resource</small></h1> |
| |
| <p></p> |
| |
| <div id="resource_XKeyREST_createKey_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/keys/key <a href="../keys/key" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Implements the create key functionality</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">provider</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <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 "Content-Type: application/json" 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_VXKmsKey.html">VXKmsKey</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_VXKmsKey.html">VXKmsKey</a> |
| (XML)</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 "Accept: application/json" 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_VXKmsKey.html">VXKmsKey</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" 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_VXKmsKey.html">VXKmsKey</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> |
| POST /keys/key |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_XKeyREST_rolloverKey_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/keys/key <a href="../keys/key" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Implements the Rollover key functionality</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">provider</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <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 "Content-Type: application/json" 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_VXKmsKey.html">VXKmsKey</a> |
| (JSON)</span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> |
| <td><span class="datatype-reference"><a href="xml_ns0_VXKmsKey.html">VXKmsKey</a> |
| (XML)</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 "Accept: application/json" 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_VXKmsKey.html">VXKmsKey</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" 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_VXKmsKey.html">VXKmsKey</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> |
| PUT /keys/key |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_XKeyREST_searchKeys_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/keys/keys <a href="../keys/keys" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Implements the traditional search functionalities for Keys</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">provider</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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 "Accept: application/json" 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_VXKmsKeyList.html">VXKmsKeyList</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" 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_VXKmsKeyList.html">VXKmsKeyList</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 /keys/keys |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "vXKeys" : [ { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| }, { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } ], |
| "listSize" : 12345, |
| "list" : [ { }, { } ], |
| "startIndex" : 12345, |
| "pageSize" : 12345, |
| "totalCount" : 12345, |
| "resultSize" : 12345, |
| "sortType" : "...", |
| "sortBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_XKeyREST_deleteKey_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/keys/key/{alias} <a href="../keys/key/{alias}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Implements the delete key functionality</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">alias</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">provider</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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 /keys/key/{alias} |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_XKeyREST_getKey_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/keys/key/{alias} <a href="../keys/key/{alias}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">alias</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">provider</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></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 "Accept: application/json" 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_VXKmsKey.html">VXKmsKey</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" 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_VXKmsKey.html">VXKmsKey</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 /keys/key/{alias} |
| Content-Type: */* |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "name" : "...", |
| "cipher" : "...", |
| "length" : 12345, |
| "description" : "...", |
| "versions" : 12345, |
| "material" : "...", |
| "versionName" : "...", |
| "created" : 12345, |
| "attributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "myClassType" : 12345, |
| "id" : 12345, |
| "createDate" : 12345, |
| "updateDate" : 12345, |
| "owner" : "...", |
| "updatedBy" : "..." |
| } |
| </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> |
