Lists all SSL/TLS certificates for a domain¶

Note

The attributes for cert and key in the API response are always empty for security reasons.

Send a GET request to the endpoint /domain/{domainId}/ssl/certificates.

Description¶

The List-SSL-Certificates request allows the user to request a list of all SSL/TLS certificates of a domain of the organisation.

Requirements¶

Values of the request: Domain ID {domainId}

Objects: none

Request¶

To request a list of all SSL/TLS certificates of a domain, the Domain-ID {domainId} needs to be added to the path of the HTTP request.

As a result, the user gets one or more objects SslCertVO and SslIntermediateVO with the requested information.

The object SslCertVO provides the following information:

Attributes	Description	Values
`subject`	The subject of the certificate.
`algorithm`	The algorithm used for encryption of the certificate.
`validFrom`	The date as ISO 8601 when the certificate starts to be valid.
`validTo`	The date as ISO 8601 until the certificate is valid.
`cert`	The attribute `cert` contains the certificate.
`fingerprint`	The fingerprint of the certificate.
`serialNumber`	The serial number of the certificate.
`subjectAlternatives`	An array of all subdomains for which the certificate is valid.
`intermediates`	One or more objects `SslIntermediateVO`.
`key`	The encrypted private key.
`wildcard`	The validity of the certificate for multiple subdomains of a domain. The certificate must have a *.domain.tld subject for `true` to be returned.	`true` `false`
`extendedValidation`	`True` if the browser treats the certificate as Extended Validation. Myra uses the OIDs of Google Chrome™ to determine the Extended Validation level.	`true` `false`
`ipList`	An array of all IPs.
`subdomains`	An array of all subdomains included in the certificate.
`certToRefresh`	The ID of the certificate to update an existing certificate.
`certRefreshForced`	Every time a certificate is renewed by another, non-matching certificate, the process is aborted with an error. If `certRefreshForced` is set, such errors are ignored and the certificate is renewed anyway. Use the attribute only if you are sure that you can ignore an error when renewing a certificate.	`true` `false`
`sniAllowed`	Defines if the Server Name Indication is allowed.	`true` `false`
`password`	The password to decrypt an encrypted certificate. An encrypted certificate should be in PKCS12 format. In this case, the attribute `cert` contains a base64-encoded value of the binary encrypted certificate (because binary content cannot be placed in a JSON field). The password field is ignored if the content of the attribute `cert` is not in PKCS12 format.
`managed`	Defines whether the certificate is managed by Myra. If the certificate is managed by Myra, it cannot be edited via the API and can only be read. The value of the attribute cannot be set when creating or updating a certificate via the API.	`true` `false`
`sslConfigurationName`	The configuration name from SSLConfiguration table.
`comment`	An individual comment for the entry.	`string`
`id`	The ID of the certificate.
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

The object SslIntermediateVO provides the following information:

Attributes	Description	Values
`subject`	The subject of the intermediate certificate.
`algorithm`	The algorithm used for encryption of the intermediate certificate.
`validFrom`	The date as ISO 8601 when the intermediate certificate starts to be valid.
`validTo`	The date as ISO 8601 until the intermediate certificate is valid.
`cert`	The attribute `cert` contains the intermediate certificate.
`fingerprint`	The fingerprint of the intermediate certificate.
`serialNumber`	The serial number of the intermediate certificate.
`issuer`	The name of the certificate issuer.
`comment`	An individual comment for the entry.	`string`
`id`	The ID of the intermediate certificate.
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "subject": "string",
    "algorithm": "string",
    "validFrom": "string",
    "validTo": "string",
    "cert": "string",
    "fingerprint": "string",
    "serialNumber": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "string",
    "subjectAlternatives": [
      "string"
    ],
    "intermediates": [
      {
        "objectType": "string",
        "subject": "string",
        "algorithm": "string",
        "validFrom": "string",
        "validTo": "string",
        "cert": "string",
        "fingerprint": "string",
        "serialNumber": "string",
        "id": 0,
        "modified": "string",
        "created": "string",
        "comment": "string",
        "issuer": "string"
      }
    ],
    "key": "string",
    "wildcard": true,
    "extendedValidation": true,
    "ipList": "string",
    "subdomains": "string",
    "certToRefresh": 0,
    "certRefreshForced": true,
    "sniAllowed": true,
    "password": "string",
    "managed": true,
    "multidomain": true,
    "sslConfigurationName": "string",
    "requestId": 0
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
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.