GRgravitee-io
Certificates
Domains

List a domain's certificates

Changed on

Returns all certificates managed by the Automation API under the domain. Certificates created outside the Automation API are not returned.

get/organizations/{orgId}/environments/{envId}/domains/{domainKey}/certificates

Request

  • Base URL
    http://localhost:8093/automation
  • URL
    http://localhost:8093/automation/organizations/{orgId}/environments/{envId}/domains/{domainKey}/certificates
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the resource belongs to.

domainKeystring required

Key of the domain: its stable, immutable Automation identifier within the environment.

Response

List of certificates

configurationstring

Plugin-specific configuration as a JSON-encoded string. Its shape is defined by the selected certificate type. Sensitive values, as flagged by the plugin, are returned as ******** in every response; an unset sensitive value is omitted. Sending ******** back on update keeps the stored value; sending it on create is rejected. The uploaded keystore file is masked too; sending ******** back keeps it.

createdAtstring date-time

Creation timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

expiresAtstring date-time

Expiry timestamp (ISO-8601 / RFC 3339, UTC), when known for the certificate type. Read-only.

keystring required

Stable, immutable identifier for the certificate within its domain. Lowercase alphanumeric and hyphens, starting and ending with an alphanumeric character. Used to identify the certificate on create-or-update.

namestring

Human-readable name of the certificate.

systemboolean

Whether this is the domain's system certificate. Immutable after creation. When true, only key is required; the certificate is built from the domains.certificates.default.* system settings and the name, type, and configuration fields are ignored.

typestring

Certificate plugin type identifier. Immutable after creation.

updatedAtstring date-time

Last-update timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

Example response

[
  {
    "configuration": "{\"jks\":{\"content\":\"...\",\"name\":\"keystore.jks\"},\"storepass\":\"secret\",\"alias\":\"mykey\",\"keypass\":\"secret\"}",
    "key": "signing-cert",
    "name": "Signing certificate",
    "type": "javakeystore-am-certificate"
  }
]

Changes