Keystore Migration Integration Point

The integration point migrates keystores stored in secret between different versions of the same application. This is an important step when upgrading an application to a newer version.

Operations

GET

The GET request exports keystore’s data from an older version of an application.

Request

GET http://[hostName]:[portNumber]/[api-context-root]/keystores/export

The request returns a JSON file with secretly-stored keystore. The response file has a unique name say, <uniquefilename>.json.

Response

{
  "keyStoreName": "keyStore",
  "keyStorePassword": "<keystorepassword>",
  "aliases": [
    {{{}}
      "aliasName": "key",
      "issuer": "CN=OHI",
      "subject": "CN=client",
      "startDate": 1695743065948,
      "validityDays": 1,
      "keyAliasPassword": "<keyaliaspassword>",
      "aliasCertificate": "<certificate>"
}

POST

The POST request imports keystore’s data to the newer version of the application. The POST request registers all keystore from the older version of the application to the newly-configured keystore on the fresh application.

Request

The request accepts a multipart/form-data and takes a file as input (for example, keystore.json). The parameter name for the request is keystore.

Request

POST http://[hostName]:[portNumber]/[api-context-root]/keystores/import

The operation returns an HTTP 204 (No Content) response if the operation succeeds, else reports an HTTP 404 error.