PUT /signingCertificate

Use the PUT method to generate a new Certificate Authority (CA) root certificate in Lenovo XClarity Administrator and creates a job to send the certificate to all managed devices.

When a new CA root certificate is generated and, a job is created to provision the new certificate to all managed devices. Use the GET /signingCertificate/jobs/<job_id> method to retrieve the job status and additional job details. If a job was not successfully started, refer to the response code and response body for details.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/signingCertificate

Query parameters

None

Request body

None

Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. A descriptive error message will be returned in the body.
404 Not found. The specified URI is not valid. A descriptive error message will be returned in the body.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
response Object Response content

This attribute is provided only if the CA that is specified in the certification chain is new and returnJobInfo="true" is specified in the request.

  jobPath String URI in the form /serverCertificate/jobs/{job_id} (for example, /serverCertificate/jobs/383) that represents the job that is monitored by the management server. You can use GET /signingCertificate/jobs/<job_id> to determine the status of the job. If a job was not successfully started, refer to the response code and response body for details.

This is the same URI that is included in the response header.

If no job was created, this attribute is empty.

result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
messages Array Information about one or more messages
  explanation String Additional information to clarify the reason for the message
  id String Identifier of the returned message
  recovery Array Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
  text String Message text associated with the message identifier

Response example

{
    "response": {
        "jobPath": "/signingCertificate/jobs/383"
    },
    "result": "success",
    "messages": [{
        "explanation": "The CA root certificate was regenerated.",
        "id": "FQXHMSE0132I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request to generate the CA root certificate was successful."
    }]
}