v1

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-06-26162897.8 KB
Certificates
Domains

Create or update a certificate

Idempotent create-or-update. Uses the key field in the body to identify the certificate within the domain. Re-applying an unchanged definition is a no-op. The system flag is immutable; changing it requires deleting and recreating the certificate.

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

Path parameters

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the domain belongs to.

domainKeystring required

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

Request body

configurationstring

Plugin-specific configuration as a JSON-encoded string. Its shape is defined by the selected certificate type.

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 request

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

Response

The created or updated certificate

configurationstring

Plugin-specific configuration as a JSON-encoded string. Its shape is defined by the selected certificate type.

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"
}