Get TLS certificate

GET /platform/configuration/security/tls/{service_name}

Retrieves a certificate in the TLS certificate chain.

Path parameters

  • service_name string Required

    The service certificate chain to read.

    Values are adminconsole, proxy, ui, or internalca.

Responses

  • 200

    The TLS certificate chain, with private key omitted, for the given service and whether it was user specified

    Hide response attributes Show response attributes object
    • user_supplied boolean Required

      Was this certificate chain user supplied or automatically generated?

    • chain array[string] Required

      The list of PEM encoded X509 certificates that make up the certificate chain

    • chain_status object

      Details on the validity and lifetime of the certification chain

      Additional properties are allowed.

      Hide chain_status attributes Show chain_status attributes object
      • expiration_date string(date-time) Required

        When this chain is going to expire due any of its certificates expiring (ISO format in UTC)

      • first_certificate_to_expire string Required

        Information on the first certificate expiring in the chain

    • api_managed boolean

      Whether or not this certificate can be updated using the API
GET /platform/configuration/security/tls/{service_name} 
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/security/tls/{service_name}
Response examples (200) 
{
  "user_supplied": true,
  "chain": [
    "string"
  ],
  "chain_status": {
    "expiration_date": "2024-05-04T09:42:00+00:00",
    "first_certificate_to_expire": "string"
  },
  "api_managed": true
}