KMS Resource

Class providing the REST bindings, via Jersey, for the KMS.

POST /v1/keys

Request Body
media type data type
application/json (custom)
Response Body
media type data type description
application/json (custom)

Example

Request
POST /v1/keys
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /v1/key/{name}

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/xml anyType (XML)

Example

Request
DELETE /v1/key/{name}
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

GET /v1/key/{name}

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/xml anyType (XML)

Example

Request
GET /v1/key/{name}
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml

                
...

POST /v1/key/{name}

Request Parameters
name type description constraints
name path regex: .*
Request Body
media type data type
application/json (custom)
Response Body
media type data type description
application/json (custom)

Example

Request
POST /v1/key/{name}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/keys/metadata

Request Parameters
name type description multivalued
key query yes
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/keys/metadata
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/keys/names

Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/keys/names
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/keyversion/{versionName}

Request Parameters
name type description constraints
versionName path regex: .*
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/keyversion/{versionName}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/key/{name}/_currentversion

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/key/{name}/_currentversion
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/key/{name}/_eek

Request Parameters
name type description default constraints
name path   regex: .*
eek_op query    
num_keys query 1 int
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/key/{name}/_eek
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/key/{name}/_invalidatecache

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/xml anyType (XML)

Example

Request
POST /v1/key/{name}/_invalidatecache
Content-Type: */*
Accept: application/xml

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/xml

                
...

GET /v1/key/{name}/_metadata

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/key/{name}/_metadata
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/key/{name}/_reencryptbatch

Request Parameters
name type description constraints
name path regex: .*
Request Body
media type data type
application/json (custom)
Response Body
media type data type description
application/json (custom)

Example

Request
POST /v1/key/{name}/_reencryptbatch
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/key/{name}/_versions

Request Parameters
name type description constraints
name path regex: .*
Response Body
media type data type description
application/json (custom)

Example

Request
GET /v1/key/{name}/_versions
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/keyversion/{versionName}/_eek

Request Parameters
name type description constraints
versionName path regex: .*
eek_op query  
Request Body
media type data type
application/xml (custom) (XML)
Response Body
media type data type description
application/json (custom)

Example

Request
POST /v1/keyversion/{versionName}/_eek
Content-Type: application/xml
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...