GET /api/v1/maintenance/certificateSigningRequest
Use this method to return or save (export) the current Certificate Signing Request (CSR).
Authentication
Authentication with user name and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/maintenance/certificateSigningRequest
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| format={type} | Optional | Response format. This can be one of the following values.
|
The following example retrieves the current CSR in JSON format.
GET https://192.0.2.0/api/v1/maintenance/certificateSigningRequest
The following example exports the current CSR as a file in PEM format.
GET https://192.0.2.0/api/v1/maintenance/certificateSigningRequest?format=pem
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. If a query parameter is specified and the value of that parameter has no matches, the response body returns default values. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
When format=pem is specified, the response body is returned only when the request generates an error (see Status messages).
When format=json is specified and the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| pem | String | CSR, in PEM format | ||
| _links | Object | CSR URI (see Links) | ||
The certificate signing request is returned if the request is successful, for example:
{
"pem": "-----BEGIN CERTIFICATE REQUEST-----MIIDjDCCAnQCAQAwgYoxCzAJBgNVBA
YTAlVTMRcwFQYDVQQIEw5Ob3J0aCBDYXJvbGluYTEQMA4GA1UEBxMHUmFsZWlnaDElMCMGA1UECh
McR2VuZXJhdGVkIGJ5IFNlcnZlciBGaXJtd2FyZTEaMBgGA1UECxMRT3JnYW5pemF0aW9uIHVuaX
QxDTALBgNVBAMTBExYQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCMwy8q5PrWhH
tLv1c0OdVJiXTHK3JNcQXicWXzL3/+vhGkgfd8rqqCvvxjTg7N2hYaFlQghEFTEWDhMmxvMFZtAh
QfBnzcdiWj23I3MSRqDWBa8NsqHWffxyqcOEqhoGiOMCjHW9zdkSkJ0fZvFJ5RTPmhY+Xnt92lZg
SGwmnTcGq9dxNvV6ixMvnHzWE9+MguTxsfGMSRZJ4Rf+d35X9ovQHEge1jMaqOcoBuqVMK9TkWsb
101GJ2tggDR5tp8YHws7wakp1isXc4AtDDIzrKfhxvxqTHqsAppREQD79srzsG+jNsOYvg7Jd7bm
2/zP9gxMwVFUY0m7DYg8HF6mZ9AgMBAAGggbswgbgGCSqGSIb3DQEJDjGBqjCBpzCBpAYDVR0RBI
GcMIGZhxD+gAAAAAAAAAoAJ//+zQ6Dgh5mZTgwOjA6MDowOmEwMDoyN2ZmOmZlY2Q6ZTgzJTKHBA
rxieCCIGlwMTAtMjQxLTEzNy0yMjQubGFicy5sZW5vdm8uY29thxAAAAAAAAAAAAAAAAAAAAABgg
lsb2NhbGhvc3SHBH8AAAGCCWxvY2FsaG9zdIIJbG9jYWxob3N0ggRMWENBMA0GCSqGSIb3DQEBCw
UAA4IBAQACBKc6nxzo/8NBQ0xuRe+wOMNzrAg9cIyh7cFCcTbSVmamOxAauRHvVIsgE/x/xQP3tQ
FvfJOqYr4eyJvEqHINY71ZgQjIunMVX90qf5MEdbYEsQE7g/2WzVXIDZ6p1qewjW85YeunHVS3fg
WfD3jXZ66BXZyEB4l7xRt0r85E6bCkhlymj3O6OLHCdmeCewT/rOaOKnR9trSBB2zSkqTPSaxJQX
B+6rKS+DGu+lSCNHYLr8cKYloLaGO8GaRZF4kedPQ1JSoz4jX0dgkPzqAXJl0JVWPUEkKLpGUomB
BBUK5PwBN1OkuB8c/wXhB9+ki3CpcolGXoBpJk+fM6ij/8-----END CERTIFICATE REQUEST-----",
"_links": {
"rel": "self",
"uri": "/api/v1/maintenance/certificateSigningRequest"
}
}
Give feedback