get-certificates.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. --
  2. :api: get-certificates
  3. :response: GetSslCertificatesResponse
  4. --
  5. [id="{upid}-{api}"]
  6. === SSL Certificate API
  7. [id="{upid}-{api}-request"]
  8. ==== Get Certificates Request
  9. The X.509 Certificates that are used to encrypt communications in an
  10. Elasticsearch cluster using the `security().getSslCertificates()` method:
  11. ["source","java",subs="attributes,callouts,macros"]
  12. --------------------------------------------------
  13. include-tagged::{doc-tests}/SecurityDocumentationIT.java[{api}-execute]
  14. --------------------------------------------------
  15. [id="{upid}-{api}-response"]
  16. ==== Get Certificates Response
  17. The returned +{response}+ contains a single field, `certificates`.
  18. This field, accessed with `getCertificates` returns a List of `CertificateInfo`
  19. objects containing the information for all the certificates used.
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests}/SecurityDocumentationIT.java[{api}-response]
  23. --------------------------------------------------
  24. <1> `certificates` is a List of `CertificateInfo`
  25. include::../execution.asciidoc[]