POST /serverCertificate

Use the POST method to uploads a new signed server certificate to Lenovo XClarity Administrator and provisions the new certificate to all managed devices.

When a self-signed certificate is generated and, a job is created to provision the new certificate to all managed devices. Use the GET /serverCertificate/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.

Note: If the CA chain that you are importing has the same certificate as a CA certificate that is already installed, the CA certificate is not sent to all management devices and no job is created.

Authentication

Authentication with user name and password is required.

Request URL

POST https://<management_server_IP>/serverCertificate

Query parameters

None

Request body

Parameters Required / Optional Type Description
action Optional String Action to take. This can be one of the following values.
  • import. Imports the new certificate. This is the default value.

  • resume. Resumes installation.

<server_certificate> Required String Server certificate in PEM forma

The certificate to be uploaded must have been created from the certificate signing request using the GET /certificateSigningRequest or downloaded from the XClarity Administrator user interface.

Request example
-----------------------------269032580128512  Content-Disposition
: form-data; name="uploadedfile"; filename="cert_chain.pem"  Cont
ent-Type: application/octet-stream   -----BEGIN CERTIFICATE-----  
MIIF8TCCA9mgAwIBAgIJAPCc80vvkTPlMA0GCSqGSIb3DQEBBQUAMIGOMQswCQYD  
VQQGEwJVUzESMBAGA1UECAwJTWlubmVzb3RhMRIwEAYDVQQHDAlSb2NoZXN0ZXIx  
EzARBgNVBAoMCnhITUMgTWFrZXIxCzAJBgNVBAsMAklTMRAwDgYDVQQDDAdUZXN0  
IENBMSMwIQYJKoZIhvcNAQkBFhRwa2lhZG1pbkBleGFtcGxlLmNvbTAeFw0xNTAz 
MDIyMDEwMDNaFw0yNTAyMjcyMDEwMDNaMIGOMQswCQYDVQQGEwJVUzESMBAGA1UE  
CAwJTWlubmVzb3RhMRIwEAYDVQQHDAlSb2NoZXN0ZXIxEzARBgNVBAoMCnhITUMg  
TWFrZXIxCzAJBgNVBAsMAklTMRAwDgYDVQQDDAdUZXN0IENBMSMwIQYJKoZIhvcN  
AQkBFhRwa2lhZG1pbkBleGFtcGxlLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIP  
ADCCAgoCggIBAMjv1twLYnr2r4lcXOMtIhHRmCjx5x9IPsm8yma028MgwHRaxDUE  
Peu2NuCJobHg1kcLyIHNPZriWXY2D4tZsYstGLNPCxLYGkJgBwGSW3KDnr4//0xF
/ftXt6kXi/Sb7ErFAuw7zKmC0RlOioU15LM1Vt4oKVJkTlOEOvKs4tlY8gB/vfaJ
wLOizJn7f/LQDccE/KBHN+6jtUgTNUDOMZprLMojdc+QLe2P2nW3NamdJh9Hc64t  

... certificate contents here ...

N/vYEzL5ll90DUcvIfZkOESgMoZ0HwKUndizfFuplSR2iXlIdUAoqZ1LAgMBAAGj  
UDBOMB0GA1UdDgQWBBS7M179cu/wan0CqJMM7+6eM18AozAfBgNVHSMEGDAWgBS7
M179cu/wan0CqJMM7+6eM18AozAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA  
A4ICAQCyDeLKYJeK85amA36yiO8pOWC+EgKhA7MhzAij+/yoprofLQ01+ovSu0HQ 
jpjh7s67OlIZC6+40o7sntk1fjQHoSpoE2B3/dmXMtxkRDTp1Z2kJaa0oV1dmEkM  
23l8M1vZ0NTy9vb4STxFUBxQ9wEKA7aNKBHnUnwZu3H0eQ6lzO0f7ZRlGANIT2mR  
NsxIPVcjXZcqsK5s1l+CSEOhjAPBsBnhSYYPDC8Z+OjtztljwuIcODO8tgr3NZZ/  
4NRMCugAZLQU1CcdQKwgQA5OYIQM1yFzFl6U61PN0QefWE3tb/0v7tFmMf7EAQbU
wkjsQUrlQakAFJUJ9Sosb1Q/p8VoMY5f52coEI/AzV8cO5t59NHHPInOgF/S9l1v  
vBC04J+lPyVxVdKnwS2EpIWRSMgwbb1Iz1pTyexBBVi3NzC5R1oaZKHsLGmbC1Hh  
B5HHZcEBOzUQtJjnEVeLTAGCQiPQzMv8OxI+dWRgIdutKZoIB5xMCXhFyXCgGUPj  
SkGjoFJL46mqE5u+qqdv1a6lKy+KDBkQg4J4hyjG0f4Y/YPkoszVy9jRaeImE5Bi  
R56ttIkp4K5yCCJVNT8Wou8b8hYh1qYUGLs+j0ixs5rtbbGAVCntj0hbFEiC5obL
1l8DI0HqZiX6XnRTwIj0Zq+JJYMdc1ikM+j/C5oN5TVb7cHlFA==  -----END CE
RTIFICATE-----  -----BEGIN CERTIFICATE-----  MIIF4zCCA8ugAwIBAgICE
AAwDQYJKoZIhvcNAQEFBQAwgY4xCzAJBgNVBAYTAlVT  MRIwEAYDVQQIDAlNaW5u
ZXNvdGExEjAQBgNVBAcMCVJvY2hlc3RlcjETMBEGA1UE  CgwKeEhNQyBNYWtlcjE
LMAkGA1UECwwCSVMxEDAOBgNVBAMMB1Rlc3QgQ0ExIzAh  BgkqhkiG9w0BCQEWFH
BraWFkbWluQGV4YW1wbGUuY29tMB4XDTEwMDEwMTEyMDAw  MFoXDTI1MDIyNzIwM
TQyMVowgYcxCzAJBgNVBAYTAlVTMRIwEAYDVQQIDAlNaW5u  ZXNvdGExEzARBgNV
BAoMCnhITUMgTWFrZXIxCzAJBgNVBAsMAklTMR0wGwYDVQQD  DBRUZXN0IEludGV
ybWVkaWF0ZSBDQTEjMCEGCSqGSIb3DQEJARYUcGtpYWRtaW5A  ZXhhbXBsZS5jb2
0wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDBHJXF  IJWrcN3O705yS
N0fpkW7psgYddhn5vJzsyqMBTDR9g07oIeI+YLkD2Za414Bl8m0  zxEizsOl8YiY
dASh5UF2zsiKt1o9FkNprdqTfAjEbq/gNDOe8ju6c/DTE2KFsuI3  8U2xSSuarAn
+QGHq186pXPwY7r3MkY6adiiOOYylbr2a7qzEfCmQavh3FpsUJ4+x
 QqJUXsfrcEd5sQwYXP/uyAvucONlz/1nmomoVC+YSaVX7tfzLlaZ4jZe2kamNRAf  
 W1elXOohVa8j6SqS53IHuUXIgb+DQyqoIXb9DdceyQc0wdObAU0cRCuKA7Jj+e1P  
 cgUnlxMap0lUQ9pRJjn9enPIau01IjREFvKxfr3hajHLg26q4uoS2dJJhlTDGEnb
 C1lZf+/FBOkFk+vdjXDdq/5Kl4RrKOaX5uQhHVb6sYBafhjQ/QIpSAyUrFcANInE  
 AOzn9GpBSgcacJYI4k86BYjEkgKoALqoTShLRk2Go3rpIIpOYpVP81saT1x0uCAX  

 ...certificate contents here ...

 vdLkS4Bw+vmMYbR6MSA9HqToDc0l2TbAjttGImlg7K7HFHybIp4QnofrdYJ7fbwV  
 bmoKLOQL60wX0efqp7r6eKIP+uYNVEYr4gXvYUn+PPqZaViRTrhIuWUQydQApeI7  
 RAaypfTGvUy8f3ezpR8+JHr+Yp4AbQeLmqJU7LgCI6fbGdVK8fwlYNs0YbCmyrcq
 EKMlRjc15pBp7ZGm/zxErn9c+CK6c+s=  -----END CERTIFICATE----- -----
BEGIN CERTIFICATE-----  MIIFyDCCA7CgAwIBAgICEAIwDQYJKoZIhvcNAQEFB
QAwgYcxCzAJBgNVBAYTAlVT  MRIwEAYDVQQIDAlNaW5uZXNvdGExEzARBgNVBAoM
CnhITUMgTWFrZXIxCzAJBgNV  BAsMAklTMR0wGwYDVQQDDBRUZXN0IEludGVybWV
kaWF0ZSBDQTEjMCEGCSqGSIb3  DQEJARYUcGtpYWRtaW5AZXhhbXBsZS5jb20wHh
cNMTAwMTAxMTIwMDAwWhcNMjUw  MjI3MjEwMzI1WjB5MQswCQYDVQQGEwJVUzESM
BAGA1UECBMJTWlubmVzb3RhMRIw  EAYDVQQHEwlSb2NoZXN0ZXIxJTAjBgNVBAoT
HEdlbmVyYXRlZCBieSBTZXJ2ZXIg  RmlybXdhcmUxCzAJBgNVBAsTAk9VMQ4wDAY
DVQQDEwVMWENBMjCCASIwDQYJKoZI  hvcNAQEBBQADggEPADCCAQoCggEBALoiw8
KeONj2+8xNrXlUs1CK5h7uAksVf1d4  +34UqdVOVeM89NjG6I4g9s8+c46ugRxXC
AnsLDWAdHqNcMz+VAc7Avn68BqwWkMF  mzboe7sgb0BK5ALEBruH+sashz84m/DX
NDCqXSg8FndU45z90pRsTAHCSC9i4Dt0  AMo6vgB3Mq90/IyfrZcd+IhPZIh0Tw0
brPssNXHJ0INRwLQ7orUOaeoi3hggkobX  LmPm6pmMqVFeSvpaGKVOXPSANvE68D
f3SZv9U9aAzg6jlehwn+CqzYmXkoIHWRIh  S0jvsV2SqAjVTHJJqZwOqFbS9BSQL
/hNT98ad/AFdU0kI7VgNCsCAwEAAaOCAUkw  ggFFMAkGA1UdEwQCMAAwEQYJYIZI
AYb4QgEBBAQDAgZAMAsGA1UdDwQEAwIF4DAw  BglghkgBhvhCAQ0EIxYhT3BlblN
TTCBHZW5lcmF0ZWQgU0FOIENlcnRpZmljYXRl  MB0GA1UdDgQWBBRYUEiNjENDqU
5FNClJxYOjK+6jqzAfBgNVHSMEGDAWgBRWpDFJ  Hnw3CSSeR102WOAlepPskzCBp
QYDVR0RBIGdMIGahxD+gAAAAAAAAAoAJ//+njAT  gh9mZTgwOjA6MDowOmEwMDoy
N2ZmOmZlOWU6MzAxMyUyhwQK8Yn6giBpcDEwLTI0  MS0xMzctMjUwLmxhYnMubGV
ub3ZvLmNvbYcQAAAAAAAAAAAAAAAAAAAAAYIJbG9j  YWxob3N0hwR/AAABgglsb2
NhbGhvc3SCCWxvY2FsaG9zdIIETFhDQTANBgkqhkiG  9w0BAQUFAAOCAgEAcm34H
7jhHFNqduuStMOY5FTkSFpJ1EdUDs5FEYh93PHNofCa  0IPb45ANeKq1KxmE4KTZ
lTrqiHKNcomEcwht2JlFfrqCq5oS4UoTOPtt278ScVHr  BTS1QTIKdLa/A2t5R89
WVVSIqRfPfjuRbrCMVTYBKSzQkv8LwI0F7C+Rq94IhQT2  jGJKilTg1qrFgOJxp7
sZSaYauhbUsedh6p3QZVl12NqJq/RezU0hQr4bAmnzJfv6  5U02bU5i85HQFBokq
3sx8lkNeWgnPWWARrRDDdfTErrirpEBCodwMSbcE25Jo2Kw  HyJYZy/S7GnnNvVP
aGabPhE2ztIubKo5lYPEgvxJldEmbxZ5u8LN3rcSjeOtvM7u  Gb/xYPiyH89ptHR
G+XnwK1fxapCeiIjQbK9exvXIOsXFJulIKIrPpch/+QHjZK7H  AQjVUVfV5vM+62
2U1tdwmj7PlAyYXjBpZYT0whnNT1RUFypy5VOZr2/D/1rCrgCy  uNodqiPkeQzfk
5xE8Sxq1Zkw/I6c905g222g3lY3Lr88u9+8Q5f1NlQpqc5wDaiw  qoX92ToEHWdz
+z7V6NhlXlhASOPmBWPPmQg+yOoeYmKl0w71AEk1R6dYSzZoxr9b  5H4ITTC3kQZ
Qn4vR9+QWvVzQSMZ7xubiSo3DrahV81pYWXcSsYVJ+3C53vM=  ---
--END CERTIFICATE-----   -----------------------------269032580128
512--

Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. A descriptive error message will be returned in the body.
409 Conflict. The certificate conflicts with current NIST settings. 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 A 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 /serverCertificate/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 The 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 The message identifier of a 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": "/serverCertificate/jobs/383"
    },
    "result": "success",
    "messages": [{
        "explanation": "The existing server certificate has been replaced by the new certificate",
        "id": "FQXHMSE0134I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request to upload new server certificate was successful.",
    }]
}