.. _envoy_v3_api_file_envoy/admin/v3/certs.proto: Certificates ============ This documentation is for the Envoy v3 API. As of Envoy v1.18 the v2 API has been removed and is no longer supported. If you are upgrading from v2 API config you may wish to view the v2 API documentation: :ref:`admin/v2alpha/certs.proto ` .. _envoy_v3_api_msg_admin.v3.Certificates: admin.v3.Certificates --------------------- :repo:`[admin.v3.Certificates proto] ` Proto representation of certificate details. Admin endpoint uses this wrapper for `/certs` to display certificate information. See :ref:`/certs ` for more information. .. code-block:: json { "certificates": [] } .. _envoy_v3_api_field_admin.v3.Certificates.certificates: certificates (**repeated** :ref:`admin.v3.Certificate `) List of certificates known to an Envoy. .. _envoy_v3_api_msg_admin.v3.Certificate: admin.v3.Certificate -------------------- :repo:`[admin.v3.Certificate proto] ` .. code-block:: json { "ca_cert": [], "cert_chain": [] } .. _envoy_v3_api_field_admin.v3.Certificate.ca_cert: ca_cert (**repeated** :ref:`admin.v3.CertificateDetails `) Details of CA certificate. .. _envoy_v3_api_field_admin.v3.Certificate.cert_chain: cert_chain (**repeated** :ref:`admin.v3.CertificateDetails `) Details of Certificate Chain .. _envoy_v3_api_msg_admin.v3.CertificateDetails: admin.v3.CertificateDetails --------------------------- :repo:`[admin.v3.CertificateDetails proto] ` .. code-block:: json { "path": "...", "serial_number": "...", "subject_alt_names": [], "days_until_expiration": "...", "valid_from": "{...}", "expiration_time": "{...}", "ocsp_details": "{...}" } .. _envoy_v3_api_field_admin.v3.CertificateDetails.path: path (`string `_) Path of the certificate. .. _envoy_v3_api_field_admin.v3.CertificateDetails.serial_number: serial_number (`string `_) Certificate Serial Number. .. _envoy_v3_api_field_admin.v3.CertificateDetails.subject_alt_names: subject_alt_names (**repeated** :ref:`admin.v3.SubjectAlternateName `) List of Subject Alternate names. .. _envoy_v3_api_field_admin.v3.CertificateDetails.days_until_expiration: days_until_expiration (`uint64 `_) Minimum of days until expiration of certificate and it's chain. .. _envoy_v3_api_field_admin.v3.CertificateDetails.valid_from: valid_from (`Timestamp `_) Indicates the time from which the certificate is valid. .. _envoy_v3_api_field_admin.v3.CertificateDetails.expiration_time: expiration_time (`Timestamp `_) Indicates the time at which the certificate expires. .. _envoy_v3_api_field_admin.v3.CertificateDetails.ocsp_details: ocsp_details (:ref:`admin.v3.CertificateDetails.OcspDetails `) Details related to the OCSP response associated with this certificate, if any. .. _envoy_v3_api_msg_admin.v3.CertificateDetails.OcspDetails: admin.v3.CertificateDetails.OcspDetails --------------------------------------- :repo:`[admin.v3.CertificateDetails.OcspDetails proto] ` .. code-block:: json { "valid_from": "{...}", "expiration": "{...}" } .. _envoy_v3_api_field_admin.v3.CertificateDetails.OcspDetails.valid_from: valid_from (`Timestamp `_) Indicates the time from which the OCSP response is valid. .. _envoy_v3_api_field_admin.v3.CertificateDetails.OcspDetails.expiration: expiration (`Timestamp `_) Indicates the time at which the OCSP response expires. .. _envoy_v3_api_msg_admin.v3.SubjectAlternateName: admin.v3.SubjectAlternateName ----------------------------- :repo:`[admin.v3.SubjectAlternateName proto] ` .. code-block:: json { "dns": "...", "uri": "...", "ip_address": "..." } .. _envoy_v3_api_field_admin.v3.SubjectAlternateName.dns: dns (`string `_) Subject Alternate Name. Only one of :ref:`dns `, :ref:`uri `, :ref:`ip_address ` may be set. .. _envoy_v3_api_field_admin.v3.SubjectAlternateName.uri: uri (`string `_) Subject Alternate Name. Only one of :ref:`dns `, :ref:`uri `, :ref:`ip_address ` may be set. .. _envoy_v3_api_field_admin.v3.SubjectAlternateName.ip_address: ip_address (`string `_) Subject Alternate Name. Only one of :ref:`dns `, :ref:`uri `, :ref:`ip_address ` may be set.