GET /api/v1/maintenance/certificate
Use this method to return information about or save (export) the XClarity Orchestrator server certificate.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/maintenance/certificate
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| format={type} | Optional | Response format. This can be one of the following values.
|
The following example retrieves the server certificate in JSON format.
GET https://192.0.2.0/api/v1/communications/certificates/7633531801c5688f7d3b830d57cdea73
The following example exports the server certificate as a file in PEM format.
GET https://192.0.2.0/api/v1/communications/certificates/7633531801c5688f7d3b830d57cdea73?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 | Server certificate, in PEM format | ||
| _links | Object | Server certificate URI (see Links) | ||
The following example is returned if the request is successful.
{
"pem": "-----BEGIN CERTIFICATE-----\nMIIDuDCCAqCgAwIBAgIUQ1JWiK2/0UvzWcreE
YEtuQ6TgiYwDQYJKoZIhvcNAQEL\nBQAwSzEMMAoGA1UECwwDRENHMQ8wDQYDVQQKDAZMZW5vdm8x
EDAOBgNVBAcMB1Jh\nbGVpZ2gxCzAJBgNVBAgMAk5DMQswCQYDVQQGEwJVUzAeFw0yMDEwMDgxNDU
0MDRa\nFw0zMDEwMDYxNDU0MDRaMIGSMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGTGVub3Zv\nMUUw
QwYDVQQDDDxHZW5lcmF0ZWQgYnkgTGVub3ZvIE1hbmFnZW1lbnQgRWNvc3lz\ndGVtIG9uIElQIDE
wLjI0My4xNy4xMDgxCzAJBgNVBAgMAk5DMQwwCgYDVQQLDANE\nQ0cxEDAOBgNVBAcMB1JhbGVpZ2
gwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQCfkDRxfvLmzd3QswmdFwZRR6X3jlxTh
RfHca7AwiyKX/CgOI9Vh/TCkw5W\nANlB3DdKFJSntgXTNhrjWk4y1boNDaBmr1eHFhjQYGRteHVr
fPPafSYk0AKEIsV9\nX9h8i0e7HJZeCqa0N6GqK8/uTo62kInFqqRE0YqWkO/jFdFnKFj69Nf9J0u
qABPc\nnb+tlXkWggRDrizvZMs3qRdjktd7Cl+8pbDKJuaUw9ZyfnNFWd2Rv8edITez15pU\nbJjl
YqUzGeaAr/PnxUBrlZlS9qDPUj6ZxlnxQ2yxy5xsUYVkBUmwZq5nCdQ2yLqw\nOqB5LFUvJKo3I6m
7dXL09IN8g0hDAgMBAAGjTDBKMB8GA1UdIwQYMBaAFD+FiELg\nA+OFa+IexISpy9kHuj9eMAkGA1
UdEwQCMAAwCwYDVR0PBAQDAgTwMA8GA1UdEQQI\nMAaHBArzEWwwDQYJKoZIhvcNAQELBQADggEBA
E1iJVWCtYAQ8lVtegoOnWhscUXn\nV9lwxuCUtwyKUk9eMF7syrC4TYBad3KLZT8eUvLhn2rA47dN
YHc92I9YPRR+DZZQ\nCmH3epUXcAKaeCJXSvIRPqGXH07Ziv6xi6yvu2AVbz/bQ0eSrAbFnYnvXTm
mQjhx\n06mLU3vYlG13fuJZlVRDg+ekOyKEbEyBxMPFFbz2yh/J/dJ4RzSVsOxOtcqAv+8U\nW9yq
DhK9L7ywhlblhUdeDBS/Ac0yLnRIvVPUtRK00MnCoJqEAYD1W28TGaUfqB2+\n0v4SuSuv7v6oyDS
H3bARQ4ykmyXBlzuMNjD3Pgwp6Kpq6+CEcWcB9SYQgjw=\n-----END CERTIFICATE-----\n",
"_links": {
"rel": "self",
"uri": "/api/v1/maintenance/certificate"
}
}
Give documentation feedback