Getting SSL/TLS provider credentials by the specified ID¶
Note
This request is only available to members of the root group and organisation administrators. Deleted or non-existent credentials always return a 403 response instead of a 404 response, so that their existence cannot be derived from the response.
Sends a GET request to the endpoint /ssl/providers/{id}.
Description¶
The Get-Ssl-Provider-Credentials request returns a single set of SSL/TLS provider credentials of the organisation.
Requirements¶
Values of the request: Provider-ID {id}
Objects: none
Request¶
To request a set of SSL/TLS provider credentials, add the Provider-ID {id} to the path of the request. As a result, the object SslProviderCredentialsVO with the requested information is returned.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
id |
The ID of the credentials entry. | integer |
name |
The name of the credentials entry. | string |
provider |
The ACME provider to which these credentials belong. |
|
email |
The contact email address of the ACME account. Always empty for the provider DTRUST. |
string |
endpoint |
The ACME endpoint URL. Required for the provider SECTIGO. |
string |
eabKid |
The EAB key identifier (External Account Binding) of the ACME account. | string |
eabHmac |
The EAB HMAC key of the ACME account. Only visible to Myra super admins, never returned to customer administrators. | string |
cert |
The ACME account certificate. Only visible to Myra super admins, never returned to customer administrators. | string |
privateKey |
The private key belonging to cert. Only visible to Myra super admins, never returned to customer administrators. |
string |
comment |
An individual comment for the entry. | string |
modified |
The date of the last change, in ISO 8601 format. | string($date-time) |
created |
The creation date, in ISO 8601 format. | string($date-time) |
Example¶
Example response:
{
"id": 0,
"name": "string",
"provider": "SECTIGO",
"email": "string",
"endpoint": "string",
"eabKid": "string",
"eabHmac": "string",
"cert": "string",
"privateKey": "string",
"comment": "string",
"modified": "2026-01-01T00:00:00+00:00",
"created": "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. |