Get certificate authority

GET /deployments/{deployment_id}/certificate-authority

Returns the certificate authority used to sign the certificates of this deployment.

Path parameters

Responses

  • The certificate authority used to sign the certificates of this deployment

    Hide response attributes Show response attributes object
    • public_certificates array[object] Required

      The certificates used by this certificate authority. The active certificate is the one that has been used to sign the current certificates of the Elasticsearch instances. All others are either certificates used in the past or certificates that will be used in the future when the currently active certificate expires.

      Hide public_certificates attributes Show public_certificates attributes object
      • active boolean Required

        If true, this certificate is the one which has been used to sign the current certificates. Otherwise, it may be the one that will be used when this certificate expires.

      • pem string Required

        The public certificate as string in PEM format.

      • metadata object Required

        Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write.

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • fingerprint string Required

          The fingerprint of the certificate

        • valid_to string(date-time) Required

          The expiry date of the certificate in UTC

        • valid_from string(date-time) Required

          The valid from date of the certificate in UTC

        • also_trusted_by array[string]

          Other deployments also trusting this certificate

    • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
    • The Elasticsearch Resource cannot be found. (code: deployments.deployment_resource_not_found)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /deployments/{deployment_id}/certificate-authority
curl \
 -X GET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/certificate-authority
Response examples (200)
{
  "recommended_trust_restriction": "string",
  "public_certificates": [
    {
      "active": true,
      "pem": "string",
      "metadata": {
        "fingerprint": "string",
        "valid_to": "2024-05-04T09:42:00+00:00",
        "valid_from": "2024-05-04T09:42:00+00:00",
        "also_trusted_by": [
          "string"
        ]
      }
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}