Service

List All Certificates

    List all certificates configured in the cluster.

    This endpoint returns a list of all certificates managed by certmgr,
    including both user-provided and cephadm-signed certificates.

    :param status: Filter by certificate status. Valid values: 'expired',
        'expiring', 'valid', 'invalid'
    :param scope: Filter by certificate scope. Valid values: 'SERVICE',
        'HOST', 'GLOBAL'
    :param service_type: Filter by service type. Supports wildcards
        (e.g., 'rgw*')
    :param include_cephadm_signed: If True, include cephadm-signed certificates.
        If False (default), only user-provided certificates are returned.
    :return: List of certificate objects with their details
    
get/api/service/certificate

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/service/certificate
  • Auth
    HTTP bearer

Query parameters

statusstring

Filter by certificate status (e.g., "expired", "expiring", "valid", "invalid")

scopestring

Filter by certificate scope (e.g., "service", "host", "global")

service_typestring

Filter by certificate type (e.g., "rgw*")

include_cephadm_signedboolean

Include cephadm-signed certificates in the list (default: False)

Response

OK

cert_namestring

Certificate name

common_namestring

Certificate common name (CN)

days_to_expirationinteger

Days remaining until expiration

expiry_datestring

Certificate expiration date

issuerstring

Certificate issuer distinguished name

scopestring

Certificate scope (SERVICE, HOST, or GLOBAL)

signed_bystring

Certificate issuer (user or cephadm)

statusstring

Certificate status (valid, expiring, expired, invalid)

targetstring

Certificate target (service name or hostname)

Changes

No recorded changes to this operation across all 68 revisions of this API.