kms/apidocs/resource_KMS.html (1,068 lines of code) (raw):
<!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: KMS</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: KMS</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_KMS_createKey_POST"><abbr title="POST /v1/keys"><span class="sideoverflow">POST /v1/keys</span></abbr></a></li>
<li><a href="#resource_KMS_deleteKey_DELETE"><abbr title="DELETE /v1/key/{name}"><span class="sideoverflow">DELETE /v1/key/{name}</span></abbr></a></li>
<li><a href="#resource_KMS_getKey_GET"><abbr title="GET /v1/key/{name}"><span class="sideoverflow">GET /v1/key/{name}</span></abbr></a></li>
<li><a href="#resource_KMS_rolloverKey_POST"><abbr title="POST /v1/key/{name}"><span class="sideoverflow">POST /v1/key/{name}</span></abbr></a></li>
<li><a href="#resource_KMS_getKeysMetadata_GET"><abbr title="GET /v1/keys/metadata"><span class="sideoverflow">GET /v1/keys/metadata</span></abbr></a></li>
<li><a href="#resource_KMS_getKeyNames_GET"><abbr title="GET /v1/keys/names"><span class="sideoverflow">GET /v1/keys/names</span></abbr></a></li>
<li><a href="#resource_KMS_getKeyVersion_GET"><abbr title="GET /v1/keyversion/{versionName}"><span class="sideoverflow">GET /v1/keyversion/{versionName}</span></abbr></a></li>
<li><a href="#resource_KMS_getCurrentVersion_GET"><abbr title="GET /v1/key/{name}/_currentversion"><span class="sideoverflow">GET /v1/key/{name}/_currentversion</span></abbr></a></li>
<li><a href="#resource_KMS_generateEncryptedKeys_GET"><abbr title="GET /v1/key/{name}/_eek"><span class="sideoverflow">GET /v1/key/{name}/_eek</span></abbr></a></li>
<li><a href="#resource_KMS_invalidateCache_POST"><abbr title="POST /v1/key/{name}/_invalidatecache"><span class="sideoverflow">POST /v1/key/{name}/_invalidatecache</span></abbr></a></li>
<li><a href="#resource_KMS_getMetadata_GET"><abbr title="GET /v1/key/{name}/_metadata"><span class="sideoverflow">GET /v1/key/{name}/_metadata</span></abbr></a></li>
<li><a href="#resource_KMS_reencryptEncryptedKeys_POST"><abbr title="POST /v1/key/{name}/_reencryptbatch"><span class="sideoverflow">POST /v1/key/{name}/_reencryptbatch</span></abbr></a></li>
<li><a href="#resource_KMS_getKeyVersions_GET"><abbr title="GET /v1/key/{name}/_versions"><span class="sideoverflow">GET /v1/key/{name}/_versions</span></abbr></a></li>
<li><a href="#resource_KMS_handleEncryptedKeyOp_POST"><abbr title="POST /v1/keyversion/{versionName}/_eek"><span class="sideoverflow">POST /v1/keyversion/{versionName}/_eek</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_KMS.html">KMS</a></li>
</ol>
<h1 class="page-header">KMS <small>Resource</small></h1>
<p>Class providing the REST bindings, via Jersey, for the KMS.</p>
<div id="resource_KMS_createKey_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v1/keys <a href="../v1/keys" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<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">(custom)
</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">(custom)
</span></td>
<td><span class="response-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>
POST /v1/keys
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-txt">
...
</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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_deleteKey_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v1/key/{name} <a href="../v1/key/{name}" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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/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">anyType
(XML)</span></td>
<td><span class="response-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 /v1/key/{name}
Content-Type: */*
Accept: application/xml
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 No Content
Content-Type: application/xml
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getKey_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/key/{name} <a href="../v1/key/{name}" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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/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">anyType
(XML)</span></td>
<td><span class="response-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>
GET /v1/key/{name}
Content-Type: */*
Accept: application/xml
<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/xml
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_rolloverKey_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v1/key/{name} <a href="../v1/key/{name}" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</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">(custom)
</span></td>
<td><span class="response-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>
POST /v1/key/{name}
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-txt">
...
</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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getKeysMetadata_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/keys/metadata <a href="../v1/keys/metadata" 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>
<th>multivalued</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">key</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-multivalued">yes</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/keys/metadata
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getKeyNames_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/keys/names <a href="../v1/keys/names" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/keys/names
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getKeyVersion_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/keyversion/{versionName} <a href="../v1/keyversion/{versionName}" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">versionName</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/keyversion/{versionName}
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getCurrentVersion_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/key/{name}/_currentversion <a href="../v1/key/{name}/_currentversion" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/key/{name}/_currentversion
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_generateEncryptedKeys_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/key/{name}/_eek <a href="../v1/key/{name}/_eek" 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>
<th>default</th>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-default-value"> </span></td>
<td><span class="parameter-constraints">regex: .*</span></td>
</tr>
<tr>
<td><span class="parameter-name">eek_op</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-default-value"> </span></td>
<td><span class="parameter-constraints"> </span></td>
</tr>
<tr>
<td><span class="parameter-name">num_keys</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-default-value">1</span></td>
<td><span class="parameter-constraints">int</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/key/{name}/_eek
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_invalidateCache_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v1/key/{name}/_invalidatecache <a href="../v1/key/{name}/_invalidatecache" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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/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">anyType
(XML)</span></td>
<td><span class="response-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>
POST /v1/key/{name}/_invalidatecache
Content-Type: */*
Accept: application/xml
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Created
Content-Type: application/xml
<code class="prettyprint language-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getMetadata_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/key/{name}/_metadata <a href="../v1/key/{name}/_metadata" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/key/{name}/_metadata
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_reencryptEncryptedKeys_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v1/key/{name}/_reencryptbatch <a href="../v1/key/{name}/_reencryptbatch" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</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">(custom)
</span></td>
<td><span class="response-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>
POST /v1/key/{name}/_reencryptbatch
Content-Type: application/json
Accept: application/json
<code class="prettyprint language-txt">
...
</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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_getKeyVersions_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v1/key/{name}/_versions <a href="../v1/key/{name}/_versions" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">name</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</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">(custom)
</span></td>
<td><span class="response-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>
GET /v1/key/{name}/_versions
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-txt">
...
</code>
</pre>
</div>
</div>
</div>
</div>
<div id="resource_KMS_handleEncryptedKeyOp_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v1/keyversion/{versionName}/_eek <a href="../v1/keyversion/{versionName}/_eek" 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>
<th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parameter-name">versionName</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints">regex: .*</span></td>
</tr>
<tr>
<td><span class="parameter-name">eek_op</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
<td><span class="parameter-constraints"> </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/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">(custom)
(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">(custom)
</span></td>
<td><span class="response-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>
POST /v1/keyversion/{versionName}/_eek
Content-Type: application/xml
Accept: application/json
<code class="prettyprint language-txt">
...
</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-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>