.. _envoy_v3_api_file_envoy/admin/v3/certs.proto:

Certificates
============


.. _envoy_v3_api_msg_admin.v3.Certificates:

admin.v3.Certificates
---------------------

`[admin.v3.Certificates proto] <https://github.com/envoyproxy/envoy/blob/v1.13.3/api/envoy/admin/v3/certs.proto#L17>`_

Proto representation of certificate details. Admin endpoint uses this wrapper for `/certs` to
display certificate information. See :ref:`/certs <operations_admin_interface_certs>` for more
information.

.. code-block:: json

  {
    "certificates": []
  }

.. _envoy_v3_api_field_admin.v3.Certificates.certificates:

certificates
  (:ref:`admin.v3.Certificate <envoy_v3_api_msg_admin.v3.Certificate>`) List of certificates known to an Envoy.
  
  


.. _envoy_v3_api_msg_admin.v3.Certificate:

admin.v3.Certificate
--------------------

`[admin.v3.Certificate proto] <https://github.com/envoyproxy/envoy/blob/v1.13.3/api/envoy/admin/v3/certs.proto#L24>`_


.. code-block:: json

  {
    "ca_cert": [],
    "cert_chain": []
  }

.. _envoy_v3_api_field_admin.v3.Certificate.ca_cert:

ca_cert
  (:ref:`admin.v3.CertificateDetails <envoy_v3_api_msg_admin.v3.CertificateDetails>`) Details of CA certificate.
  
  
.. _envoy_v3_api_field_admin.v3.Certificate.cert_chain:

cert_chain
  (:ref:`admin.v3.CertificateDetails <envoy_v3_api_msg_admin.v3.CertificateDetails>`) Details of Certificate Chain
  
  


.. _envoy_v3_api_msg_admin.v3.CertificateDetails:

admin.v3.CertificateDetails
---------------------------

`[admin.v3.CertificateDetails proto] <https://github.com/envoyproxy/envoy/blob/v1.13.3/api/envoy/admin/v3/certs.proto#L35>`_


.. code-block:: json

  {
    "path": "...",
    "serial_number": "...",
    "subject_alt_names": [],
    "days_until_expiration": "...",
    "valid_from": "{...}",
    "expiration_time": "{...}"
  }

.. _envoy_v3_api_field_admin.v3.CertificateDetails.path:

path
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Path of the certificate.
  
  
.. _envoy_v3_api_field_admin.v3.CertificateDetails.serial_number:

serial_number
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Certificate Serial Number.
  
  
.. _envoy_v3_api_field_admin.v3.CertificateDetails.subject_alt_names:

subject_alt_names
  (:ref:`admin.v3.SubjectAlternateName <envoy_v3_api_msg_admin.v3.SubjectAlternateName>`) List of Subject Alternate names.
  
  
.. _envoy_v3_api_field_admin.v3.CertificateDetails.days_until_expiration:

days_until_expiration
  (`uint64 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Minimum of days until expiration of certificate and it's chain.
  
  
.. _envoy_v3_api_field_admin.v3.CertificateDetails.valid_from:

valid_from
  (`Timestamp <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp>`_) Indicates the time from which the certificate is valid.
  
  
.. _envoy_v3_api_field_admin.v3.CertificateDetails.expiration_time:

expiration_time
  (`Timestamp <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp>`_) Indicates the time at which the certificate expires.
  
  


.. _envoy_v3_api_msg_admin.v3.SubjectAlternateName:

admin.v3.SubjectAlternateName
-----------------------------

`[admin.v3.SubjectAlternateName proto] <https://github.com/envoyproxy/envoy/blob/v1.13.3/api/envoy/admin/v3/certs.proto#L58>`_


.. code-block:: json

  {
    "dns": "...",
    "uri": "..."
  }

.. _envoy_v3_api_field_admin.v3.SubjectAlternateName.dns:

dns
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 
  Subject Alternate Name.
  
  
  Only one of :ref:`dns <envoy_v3_api_field_admin.v3.SubjectAlternateName.dns>`, :ref:`uri <envoy_v3_api_field_admin.v3.SubjectAlternateName.uri>` may be set.
  
.. _envoy_v3_api_field_admin.v3.SubjectAlternateName.uri:

uri
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 
  Subject Alternate Name.
  
  
  Only one of :ref:`dns <envoy_v3_api_field_admin.v3.SubjectAlternateName.dns>`, :ref:`uri <envoy_v3_api_field_admin.v3.SubjectAlternateName.uri>` may be set.