GET /certificateSigningRequest
Use this method to download or retrieve detailed information about a Certificate Signing Request (CSR).
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/certificateSigningRequest
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| details={Boolean} | Optional | Indicates whether to include message content in the response body. This can be one of the following values.
|
| path={string} | Required | ID value obtained from a previous POST /certificateSigningRequest request |
The following example downloads only the CSR.
GET /certificateSigningRequest?path=1
The following example retrieves detailed information about the CSR.
GET /certificateSigningRequest?path=1&details=true
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| response | Array | |||
| CSR | String | Certificate | ||
| result | String | Results of the request. This can be one of the following values.
| ||
| messages | Array | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | 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 | ||
The following example is returned if the request is successful and details=true was not specified.
-----BEGIN CERTIFICATE REQUEST-----
MIIDjDCCAnQCAQAwgYoxCzAJBgNVBAYTAlVTMRcwFQYDVQQIEw5Ob3J0aCBDYXJv
bGluYTEQMA4GA1UEBxMHUmFsZWlnaDElMCMGA1UEChMcR2VuZXJhdGVkIGJ5IFNl
cnZlciBGaXJtd2FyZTEaMBgGA1UECxMRT3JnYW5pemF0aW9uIHVuaXQxDTALBgNV
BAMTBExYQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCMwy8q5PrW
hHtLv1c0OdVJiXTHK3JNcQXicWXzL3/+vhGkgfd8rqqCvvxjTg7N2hYaFlQghEFT
EWDhMmxvMFZtAhQfBnzcdiWj23I3MSRqDWBa8NsqHWffxyqcOEqhoGiOMCjHW9zd
kSkJ0fZvFJ5RTPmhY+Xnt92lZgSGwmnTcGq9dxNvV6ixMvnHzWE9+MguTxsfGMSR
ZJ4Rf+d35X9ovQHEge1jMaqOcoBuqVMK9TkWsb101GJ2tggDR5tp8YHws7wakp1i
sXc4AtDDIzrKfhxvxqTHqsAppREQD79srzsG+jNsOYvg7Jd7bm2/zP9gxMwVFUY0
m7DYg8HF6mZ9AgMBAAGggbswgbgGCSqGSIb3DQEJDjGBqjCBpzCBpAYDVR0RBIGc
MIGZhxD+gAAAAAAAAAoAJ//+zQ6Dgh5mZTgwOjA6MDowOmEwMDoyN2ZmOmZlY2Q6
ZTgzJTKHBArxieCCIGlwMTAtMjQxLTEzNy0yMjQubGFicy5sZW5vdm8uY29thxAA
AAAAAAAAAAAAAAAAAAABgglsb2NhbGhvc3SHBH8AAAGCCWxvY2FsaG9zdIIJbG9j
YWxob3N0ggRMWENBMA0GCSqGSIb3DQEBCwUAA4IBAQACBKc6nxzo/8NBQ0xuRe+w
OMNzrAg9cIyh7cFCcTbSVmamOxAauRHvVIsgE/x/xQP3tQFvfJOqYr4eyJvEqHIN
Y71ZgQjIunMVX90qf5MEdbYEsQE7g/2WzVXIDZ6p1qewjW85YeunHVS3fgWfD3jX
Z66BXZyEB4l7xRt0r85E6bCkhlymj3O6OLHCdmeCewT/rOaOKnR9trSBB2zSkqTP
SaxJQXB+6rKS+DGu+lSCNHYLr8cKYloLaGO8GaRZF4kedPQ1JSoz4jX0dgkPzqAX
Jl0JVWPUEkKLpGUomBBBUK5PwBN1OkuB8c/wXhB9+ki3CpcolGXoBpJk+fM6ij/8
-----END CERTIFICATE REQUEST-----
The following example is returned if the request is successful and details=true was specified.
{
"response": {
"CSR": "-----BEGIN CERTIFICATE REQUEST-----\n
MIIDjDCCAnQCAQAwgYoxCzAJBgNVBAYTAlVTMRcwFQYDVQQIEw5Ob3J0aCBDYXJv\n
bGluYTEQMA4GA1UEBxMHUmFsZWlnaDElMCMGA1UEChMcR2VuZXJhdGVkIGJ5IFNl\n
cnZlciBGaXJtd2FyZTEaMBgGA1UECxMRT3JnYW5pemF0aW9uIHVuaXQxDTALBgNV\n
BAMTBExYQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCDeldS5sla\n
KMP5nxp1UyC233r2G3AOFnaAuFCmObgkCgfOuAfDmLvFva2P2/FGN5AfBw2ToLMC\n
A7tdExvPqawg/ByFIikn5J35Uei7j12jJjLnYAoddUKu1+OVh5wv/iWEHnZAaVZl\n
qNJbBVUGot2hl+9KCxrgphoq7uuJ9ZVVK617IkiwzQN+D5INIJRkXIQdoPxAyW53\n
J9ohkTFWDW2JOMoqSAXNOnSKOjtnzB8JVf823pb1IcmYW0pFSK+tn9mbKIo5YtzB\n
4ik9S08y3yAnMRPR1YM4UwMZi2S5MIhC+rKVd47VRpYFVS53ySGqIUY2EynEztA+\n
qucd8gS1JfItAgMBAAGggbswgbgGCSqGSIb3DQEJDjGBqjCBpzCBpAYDVR0RBIGc\n
MIGZhxD+gAAAAAAAAAoAJ//+zQ6Dgh5mZTgwOjA6MDowOmEwMDoyN2ZmOmZlY2Q6\n
ZTgzJTKHBArxieCCIGlwMTAtMjQxLTEzNy0yMjQubGFicy5sZW5vdm8uY29thxAA\n
AAAAAAAAAAAAAAAAAAABgglsb2NhbGhvc3SHBH8AAAGCCWxvY2FsaG9zdIIJbG9j\n
YWxob3N0ggRMWENBMA0GCSqGSIb3DQEBCwUAA4IBAQB5FTkUlxQ8NbcoTlUNzGzg\n
XQQM2GxfID0xzd+ZiOQpuXEdKoTc+ehGXUC0Kx5Shs2rkNAeyf5KWbWIewKOwh3v\n
SuNK4JMFguaD1o0V21XqEBEN50HOA759mN3HuKHnbWJCEERp2OZmZAJqJfAdNVY/\n
n+CC+Hsaluy4aJI2fFRJ9jod/bFVKxkvsn8XangntQK9UIUGmqhUBMFTrQfqu/i9\n
YM+8zhPJlJFL18jiqH0hMyMfDznRQQl1c9943HYJxXRFs/HWlHkpTlSovv2h4a3k\n
F3rlvLdPsd5ym97fV0/oIDPm6e27lv9B3QfSuwk6BtCYFy3evp78/daptO0KBuf6\n
-----END CERTIFICATE REQUEST-----\n"
},
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback