Get Certificates By Domain
View detailed metadata about the certificate(s) of all the resources in a domain
Domain ID or Name
3E86FBAD-8984-4D4B-992D-F0C49857572AOptional parameter to exclude a specific resource type from the API response. When provided, the response will omit certificates associated with the specified resource type.
The page number (must be a positive number), starts with 0
The page size (must be a positive number, 0 as page size returns all records in one page
Ok
{
"elements": [
{
"isInstalled": false,
"version": "V3",
"serialNumber": "46:85:19:77:36:12:67:26",
"issuedTo": "sfo-vc01.rainpole.io",
"resourceType": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"resourceName": "string",
"issuedBy": "CN=OpenSSL CA, OU=VCF, O=VMware, L=Bengaluru, ST=Karnataka, C=IN",
"notBefore": "2020-01-01T00:00:00Z",
"notAfter": "2021-02-02T00:00:00Z",
"signatureAlgorithm": "SHA256withRSA",
"subject": "CN=sfo-vc01.rainpole.io, OU=VCF, O=VMware, L=Bengaluru, ST=Karnataka, C=IN",
"domain": "3E86FBAD-8984-4D4B-992D-F0C49857572A",
"subjectAlternativeName": [
"sfo-vc01.rainpole.io"
],
"publicKey": "D6:FD:DF:33:F1:...",
"publicKeyAlgorithm": "One among: RSA",
"keySize": "One among: 2048, 3072, 4096",
"thumbprintAlgorithm": "SHA-256",
"thumbprint": "59:24:D5:18:04:A0:26:B0:A4:05:EA:82:60:95:82:A2:4B:F6:31:FB:81:93:01:F3:29:7D:34:9C:D3:05:39:90",
"numberOfDaysToExpire": 398,
"expirationStatus": "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED",
"pemEncoded": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
"getCertificateError": "Status : NOT_TRUSTED, Message : Certificate Expired",
"operationType": "One among: GENERATE_CSR, GENERATE_CERTIFICATE, REPLACE_CERTIFICATE",
"operationStatus": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"operationMessage": "string",
"caChain": [
{
"isInstalled": false,
"version": "V3",
"serialNumber": "46:85:19:77:36:12:67:26",
"issuedTo": "sfo-vc01.rainpole.io",
"resourceType": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"resourceName": "string",
"issuedBy": "CN=OpenSSL CA, OU=VCF, O=VMware, L=Bengaluru, ST=Karnataka, C=IN",
"notBefore": "2020-01-01T00:00:00Z",
"notAfter": "2021-02-02T00:00:00Z",
"signatureAlgorithm": "SHA256withRSA",
"subject": "CN=sfo-vc01.rainpole.io, OU=VCF, O=VMware, L=Bengaluru, ST=Karnataka, C=IN",
"domain": "3E86FBAD-8984-4D4B-992D-F0C49857572A",
"subjectAlternativeName": [
"sfo-vc01.rainpole.io"
],
"publicKey": "D6:FD:DF:33:F1:...",
"publicKeyAlgorithm": "One among: RSA",
"keySize": "One among: 2048, 3072, 4096",
"thumbprintAlgorithm": "SHA-256",
"thumbprint": "59:24:D5:18:04:A0:26:B0:A4:05:EA:82:60:95:82:A2:4B:F6:31:FB:81:93:01:F3:29:7D:34:9C:D3:05:39:90",
"numberOfDaysToExpire": 398,
"expirationStatus": "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED",
"pemEncoded": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
"getCertificateError": "Status : NOT_TRUSTED, Message : Certificate Expired",
"operationType": "One among: GENERATE_CSR, GENERATE_CERTIFICATE, REPLACE_CERTIFICATE",
"operationStatus": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"operationMessage": "string",
"caChain": [
"Certificate Object"
],
"domainId": "3E86FBAD-8984-4D4B-992D-F0C49857572A",
"autoRenew": "One among: NOT_SUPPORTED, ENABLED, DISABLED",
"autoRenewStatus": "One among: PENDING, SCHEDULED, FAILED",
"caType": "One among: OpenSSL, Microsoft, VMCA",
"autoRenewFailureMessage": "string"
}
],
"domainId": "3E86FBAD-8984-4D4B-992D-F0C49857572A",
"autoRenew": "One among: NOT_SUPPORTED, ENABLED, DISABLED",
"autoRenewStatus": "One among: PENDING, SCHEDULED, FAILED",
"caType": "One among: OpenSSL, Microsoft, VMCA",
"autoRenewFailureMessage": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}The list of elements included in this page
Represents pageable elements pagination metadata
Not Found
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
InternalServerError
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/domains/{id}/resource-certificates