Bulk Certificate Update REST Service

Use the Bulk Certificate Update REST Service to update communication certificates for client devices that have the same WWNN (worldwide node name) value as in the new certificate. For example, you can run this REST service to update the certificate for devices in multiple PEER_TO_PEER device groups.

Operation
PUT
URL
https://host:port/SKLM/rest/v1/certificates/bulkCertUpdate/

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

Request Parameters
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.
Request Headers
Header name Value
Content-Type multipart/form-data
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
Form parameter
Parameter name Description
fileName

Select the new certificate file. Ensure that the certificate is trusted in IBM Security Guardium Key Lifecycle Manager.

Response

Response Headers
Header name Value and description
Status Code
200 OK
The request was successful. The response body contains the requested representation.
400 Bad Request
The authentication information was not provided in the correct format.
401 Unauthorized
The authentication credentials were missing or incorrect.
404 Not Found Error
The processing of the request fails.
500 Internal Server Error
The processing of the request fails because of an unexpected condition on the server.
Content-Type application/json
Content-Language Locale for the response message.
Success response body

JSON object with the following specification:

JSON property name Description
code Returns the code that is specified by the status property.
status Returns the status message to indicate whether the certificate is updated or not.
0
The status indicates that the certificate update task succeeded.
1
The status indicates that the certificates are not updated.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
message Returns a message that describes the error.

Example

Service request to update certificates
PUT https://localhost:port/SKLM/rest/v1/certificates/bulkCertUpdate
Content-Type:  multipart/form-data; 
boundary=---------------------------293582696224464
Authorization: SKLMAuth userAuthId=139aeh34567m
-----------------------------293582696224464
Content-Disposition: form-data; name="fileName"; filename="clientcert.cer"
<File Content>
-----------------------------293582696224464
Success response
{
    "code": "0",
    "status": "CTGKM3491I Device communication certificates are updated. "
}
Service request with incorrect certificate file
PUT https://localhost:port/SKLM/rest/v1/certificates/bulkCertUpdate
accept: application/json
Accept-Language: en
Authorization: SKLMAuth userAuthId=66f06486-d67f-48ab-bd63-018dcf17e39e
Content-Type: multipart/form-data
fileName=@cert1_admin_1636341955632.cer;type=application/x-x509-ca-cert
Error response
{
    "code": "CTGKM3490E",
    "status": "CTGKM3490E Failed to update the communication certificates because the new certificate file is invalid."
}