XKeyREST Resource

POST /keys/key

Implements the create key functionality

Request Parameters
name type description
provider query
Request Body
media type data type
application/json VXKmsKey (JSON)
application/xml VXKmsKey (XML)
Response Body
media type data type description
application/json VXKmsKey (JSON)
application/xml VXKmsKey (XML)

Example

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

                
{
  "name" : "...",
  "cipher" : "...",
  "length" : 12345,
  "description" : "...",
  "versions" : 12345,
  "material" : "...",
  "versionName" : "...",
  "created" : 12345,
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "cipher" : "...",
  "length" : 12345,
  "description" : "...",
  "versions" : 12345,
  "material" : "...",
  "versionName" : "...",
  "created" : 12345,
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
                
              

PUT /keys/key

Implements the Rollover key functionality

Request Parameters
name type description
provider query
Request Body
media type data type
application/json VXKmsKey (JSON)
application/xml VXKmsKey (XML)
Response Body
media type data type description
application/json VXKmsKey (JSON)
application/xml VXKmsKey (XML)

Example

Request
PUT /keys/key
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "cipher" : "...",
  "length" : 12345,
  "description" : "...",
  "versions" : 12345,
  "material" : "...",
  "versionName" : "...",
  "created" : 12345,
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "cipher" : "...",
  "length" : 12345,
  "description" : "...",
  "versions" : 12345,
  "material" : "...",
  "versionName" : "...",
  "created" : 12345,
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}
                
              

GET /keys/keys

Implements the traditional search functionalities for Keys

Request Parameters
name type description
provider query
Response Body
media type data type description
application/json VXKmsKeyList (JSON)
application/xml VXKmsKeyList (XML)

Example

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

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

                
{
  "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" : "..."
}
                
              

DELETE /keys/key/{alias}

Implements the delete key functionality

Request Parameters
name type description
alias path
provider query

Example

Request
DELETE /keys/key/{alias}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /keys/key/{alias}

Request Parameters
name type description
alias path
provider query
Response Body
media type data type description
application/json VXKmsKey (JSON)
application/xml VXKmsKey (XML)

Example

Request
GET /keys/key/{alias}
Content-Type: */*
Accept: application/json

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

                
{
  "name" : "...",
  "cipher" : "...",
  "length" : 12345,
  "description" : "...",
  "versions" : 12345,
  "material" : "...",
  "versionName" : "...",
  "created" : 12345,
  "attributes" : {
    "property1" : "...",
    "property2" : "..."
  },
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}