Certificate Export REST Service
Use the Certificate Export REST Service to export a certificate file.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/certificates/export
By default, Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager installation, you can modify this default port.
Request
Parameter | Description |
---|---|
host | Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port | Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Header name | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
Authorization | SKLMAuth userAuthId=<authIdValue> |
Accept-Language | Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or de. |
JSON object with the following specification:
Property name | Description |
---|---|
uuid | Specify the universal unique identifier of the certificate. |
fileName | Specify the name of the file in which the exported certificate is stored. The file is stored in the SKLM_DATA directory. You can specify a directory path along with the file name as the value. If you specify the directory path, the file is stored in the path relative to the SKLM_DATA directory. For example, if you specify the value as export1/exportedCert, then the exported certificate file is stored in the following path:
|
format |
Specify any of the following formats for the file content:
|
Response
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
JSON object with the following specification:
JSON property name | Description |
---|---|
code | Returns a 0 (zero) to indicate the completion of the certificate export task. |
status | Returns the status with an appropriate message to indicate whether the certificate is exported. |
JSON object with the following specification.
JSON property name | Description |
---|---|
code | Returns the application error code. |
message | Returns a message that describes the error. |
Examples
- Service request to export a certificate
PUT https://localhost:port/SKLM/rest/v1/certificates/export Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"uuid":"CERTIFICATE-78d68704-fdde-42df-95da-debef9de930","format":"DER", "fileName":"/mycertificate.der"}
- Service request with invalid certificate format
PUT https://localhost:port/SKLM/rest/v1/certificates/export Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"uuid":"CERTIFICATE-78d68704-fdde-42df-95da-debef9de930","format":"ABC", "fileName":"/newcertificate.der"}