Skip to content

Commit e273ddd

Browse files
[OpenAPI] Edit SSL certificate API (#3056) (#3069)
(cherry picked from commit e46f571) Co-authored-by: Lisa Cawley <[email protected]>
1 parent c0d9ddb commit e273ddd

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,6 @@ actions:
183183
x-displayName: Searchable snapshots
184184
- name: security
185185
x-displayName: Security
186-
- name: ssl
187-
x-displayName: Security - SSL
188186
- name: snapshot
189187
x-displayName: Snapshot and restore
190188
description: >

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/ssl/certificates/GetCertificatesRequest.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,26 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get SSL certificates.
24+
*
25+
* Get information about the X.509 certificates that are used to encrypt communications in the cluster.
26+
* The API returns a list that includes certificates from all TLS contexts including:
27+
*
28+
* - Settings for transport and HTTP interfaces
29+
* - TLS settings that are used within authentication realms
30+
* - TLS settings for remote monitoring exporters
31+
*
32+
* The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.
33+
* It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.
34+
*
35+
* The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.
36+
*
37+
* NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.
38+
*
39+
* If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.
2340
* @rest_spec_name ssl.certificates
2441
* @availability stack since=6.2.0 stability=stable
2542
* @availability serverless stability=stable visibility=private
43+
* @doc_tag security
2644
*/
2745
export interface Request extends RequestBase {}

0 commit comments

Comments
 (0)