Getting Information About Certificates from Products (v1)

Getting Information About Certificates from Products (v1)

This endpoint returns information about all certificates for the deployed BOSH Director and the other deployed products.

Learn more about certificates managed by Ops Manager by visiting the documentation for Certificates and credentials in Tanzu Operations Manager

Improvements over the /api/v0/deployed/certificates endpoint:

  • Lists the current rotation state for each certificate. This makes it easier to see what the next step to run during a certificate rotation procedure.
  • Lists certificates associated with multiple deployments a single time with a deployments array, instead of listing the full certificate details multiple times
  • Lists which deployments are "outdated" after generating new versions of a certificate. This makes it easy to determine which tiles, service instances, and non-tile deployments still need to be redeployed to consume the new certificate.
  • Leaf certificates are nested under the CA certificate that signs them, if any. This makes it easier to determine which certificates are affected when the parent CA is rotated or expires
Request
URI
GET
https://{opsmanager-installation}//api/v1/deployed/certificates
COPY
Query Parameters
string
expires_within
Optional

expires_within

Possible values are : d, w, m, y,
boolean
no_cache
Optional

no_cache


Responses
200

OK

Returns CertificatesV1 of type(s) application/json
{
    "certificates": [
        {
            "auto_rotated": false,
            "configurable": false,
            "deployments": [
                "string"
            ],
            "is_ca": false,
            "issuer": "string",
            "location": "string",
            "name": "string",
            "outdated_deployments": [
                "string"
            ],
            "product_guid": "string",
            "property_type": "string",
            "rotation_procedure_name": "string",
            "rotation_procedure_url": "string",
            "rotation_status": "string",
            "signs": [
                "CertificateV1 Object"
            ],
            "valid_from": "string",
            "valid_until": "string"
        }
    ]
}
certificates
Optional

certificates