Getting an SSL/TLS request¶
Sends a GET request to the endpoint /ssl/requests/{id}.
Description¶
The GetSslRequest request returns the information of a single SSL/TLS request of the organisation.
Requirements¶
Values of the request: Provider-ID {id}
Objects: none
Request¶
To request the information of an SSL/TLS request, add the Provider-ID {id} to the path of the request. The object SslCertRequestVO provides the following information:
| Attributes | Description | Values |
|---|---|---|
id |
The ID of the SSL/TLS request. | integer |
algorithm |
The key algorithm used for the certificate. |
|
provider |
The SSL/TLS provider that issues the certificate. |
|
status |
The status of the SSL/TLS request. |
|
subjectAlternativeNames |
An array of SslCertRequestSanVO objects. |
array |
assignments |
An array of SslCertRequestAssignmentVO objects. |
array |
multiDomain |
Shows whether the SSL/TLS request covers more than one domain. |
|
sslProviderCredentialsId |
The ID of the object SslProviderCredentials used to issue the certificate. |
integer |
renewalInterval |
The number of days before expiry of the certificate at which the certificate is renewed. | integer |
signatureAlgorithm |
The signature algorithm used for the certificate. | string |
created |
The date on which the SSL/TLS request was created, in ISO 8601 format. | string($date-time) |
modified |
The last modification date in ISO 8601 format. | string($date-time) |
Example¶
Example response:
{
"id": 0,
"algorithm": "RSA2048",
"provider": "LETS_ENCRYPT",
"status": "OPEN",
"subjectAlternativeNames": [],
"assignments": [],
"multiDomain": true,
"sslProviderCredentialsId": 0,
"renewalInterval": 0,
"signatureAlgorithm": "string",
"created": "2026-01-01T00:00:00+00:00",
"modified": "2026-01-01T00:00:00+00:00"
}
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 401 | The request has not succeeded because the user authentication was incorrect. |
| 403 | The request has not succeeded because the user does not have the right permissions. |
| 404 | The request was unsuccessful because the requested resource was not found. |