certificate.query

Sent on certificate changes.

Type: object

ADDED

CertificateAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

CertificateEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this certificate entry.

type Required

Type

Type: integer

Internal certificate type identifier used to determine certificate capabilities.

name Required

Name

Type: string

Human-readable name for this certificate. Must be unique and contain only alphanumeric characters, dashes, and underscores.

Must be at least 1 characters long

certificate Required

Certificate

PEM-encoded X.509 certificate data. null for certificate signing requests (CSR) that have not yet been signed.

Any of

• Option 1
• Option 2

Type: string

Type: null

privatekey Required

Privatekey

PEM-encoded private key corresponding to the certificate. null if no private key is available or for imported certificates without keys.

Any of

• Option 1
• Option 2

Type: string

Type: null

CSR Required

Csr

PEM-encoded Certificate Signing Request (CSR) data. null for imported certificates or completed ACME certificates.

Any of

• Option 1
• Option 2

Type: string

Type: null

acme_uri Required

Acme Uri

ACME directory server URI used for automated certificate management. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: string

Type: null

domains_authenticators Required

Domains Authenticators

Mapping of domain names to ACME DNS authenticator IDs for domain validation. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: object

Type: null

renew_days Required

Renew Days

Number of days before expiration to attempt automatic renewal. Only applicable for ACME certificates. null for non-renewable certificates.

Any of

• Option 1
• Option 2

Type: integer

Type: null

acme Required

Acme

ACME registration and account information used for certificate lifecycle management. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: object

Type: null

add_to_trusted_store Required

Add To Trusted Store

Type: boolean

Whether this certificate should be added to the system's trusted certificate store.

root_path Required

Root Path

Type: string

Filesystem path where certificate-related files are stored.

Must be at least 1 characters long

certificate_path Required

Certificate Path

Filesystem path to the certificate file (.crt). null if no certificate is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

privatekey_path Required

Privatekey Path

Filesystem path to the private key file (.key). null if no private key is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

csr_path Required

Csr Path

Filesystem path to the certificate signing request file (.csr). null if no CSR is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

cert_type Required

Cert Type

Type: string

Human-readable certificate type, typically 'CERTIFICATE' for standard certificates.

Must be at least 1 characters long

cert_type_existing Required

Cert Type Existing

Type: boolean

Whether this is an existing certificate (imported or generated).

cert_type_CSR Required

Cert Type Csr

Type: boolean

Whether this entry represents a Certificate Signing Request (CSR) rather than a signed certificate.

cert_type_CA Required

Cert Type Ca

Type: boolean

Whether this certificate is a Certificate Authority (CA) certificate.

chain_list Required

Chain List

Type: array of string

Array of PEM-encoded certificates in the certificate chain, starting with the leaf certificate.

No Additional Items

Each item of this array must be:

Type: string

key_length Required

Key Length

Size of the cryptographic key in bits. null if key information is unavailable.

Any of

• Option 1
• Option 2

Type: integer

Type: null

key_type Required

Key Type

Type of cryptographic key algorithm (e.g., 'RSA', 'EC', 'DSA'). null if key information is unavailable.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

country Required

Country

ISO 3166-1 alpha-2 country code from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

state Required

State

State or province name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

city Required

City

City or locality name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

organization Required

Organization

Organization name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

organizational_unit Required

Organizational Unit

Organizational unit from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

common Required

Common

Common name (CN) from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

san Required

San

Subject Alternative Names (SAN) from the certificate extension. null if no SAN extension is present.

Any of

• Option 1
• Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

email Required

Email

Email address from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

DN Required

Dn

Distinguished Name (DN) of the certificate subject in RFC 2253 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

subject_name_hash Required

Subject Name Hash

Hash of the certificate subject name. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

extensions Required

Extensions

Type: object

X.509 certificate extensions parsed into a dictionary structure.

digest_algorithm Required

Digest Algorithm

Cryptographic hash algorithm used for certificate signing (e.g., 'SHA256'). null if unavailable.

Any of

• Option 1
• Option 2

Type: string

Type: null

lifetime Required

Lifetime

Certificate validity period in seconds. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

from Required

From

Certificate validity start date in ISO 8601 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

until Required

Until

Certificate validity end date in ISO 8601 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Certificate serial number. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

chain Required

Chain

Whether this certificate has an associated certificate chain. null if unavailable.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

fingerprint Required

Fingerprint

SHA-256 fingerprint of the certificate in hexadecimal format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

expired Required

Expired

Whether the certificate has expired. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

parsed Required

Parsed

Type: boolean

Whether the certificate data was successfully parsed and validated.

CHANGED

CertificateChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

CertificateEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this certificate entry.

type Required

Type

Type: integer

Internal certificate type identifier used to determine certificate capabilities.

name Required

Name

Type: string

Human-readable name for this certificate. Must be unique and contain only alphanumeric characters, dashes, and underscores.

Must be at least 1 characters long

certificate Required

Certificate

PEM-encoded X.509 certificate data. null for certificate signing requests (CSR) that have not yet been signed.

Any of

• Option 1
• Option 2

Type: string

Type: null

privatekey Required

Privatekey

PEM-encoded private key corresponding to the certificate. null if no private key is available or for imported certificates without keys.

Any of

• Option 1
• Option 2

Type: string

Type: null

CSR Required

Csr

PEM-encoded Certificate Signing Request (CSR) data. null for imported certificates or completed ACME certificates.

Any of

• Option 1
• Option 2

Type: string

Type: null

acme_uri Required

Acme Uri

ACME directory server URI used for automated certificate management. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: string

Type: null

domains_authenticators Required

Domains Authenticators

Mapping of domain names to ACME DNS authenticator IDs for domain validation. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: object

Type: null

renew_days Required

Renew Days

Number of days before expiration to attempt automatic renewal. Only applicable for ACME certificates. null for non-renewable certificates.

Any of

• Option 1
• Option 2

Type: integer

Type: null

acme Required

Acme

ACME registration and account information used for certificate lifecycle management. null for non-ACME certificates.

Any of

• Option 1
• Option 2

Type: object

Type: null

add_to_trusted_store Required

Add To Trusted Store

Type: boolean

Whether this certificate should be added to the system's trusted certificate store.

root_path Required

Root Path

Type: string

Filesystem path where certificate-related files are stored.

Must be at least 1 characters long

certificate_path Required

Certificate Path

Filesystem path to the certificate file (.crt). null if no certificate is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

privatekey_path Required

Privatekey Path

Filesystem path to the private key file (.key). null if no private key is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

csr_path Required

Csr Path

Filesystem path to the certificate signing request file (.csr). null if no CSR is available.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

cert_type Required

Cert Type

Type: string

Human-readable certificate type, typically 'CERTIFICATE' for standard certificates.

Must be at least 1 characters long

cert_type_existing Required

Cert Type Existing

Type: boolean

Whether this is an existing certificate (imported or generated).

cert_type_CSR Required

Cert Type Csr

Type: boolean

Whether this entry represents a Certificate Signing Request (CSR) rather than a signed certificate.

cert_type_CA Required

Cert Type Ca

Type: boolean

Whether this certificate is a Certificate Authority (CA) certificate.

chain_list Required

Chain List

Type: array of string

Array of PEM-encoded certificates in the certificate chain, starting with the leaf certificate.

No Additional Items

Each item of this array must be:

Type: string

key_length Required

Key Length

Size of the cryptographic key in bits. null if key information is unavailable.

Any of

• Option 1
• Option 2

Type: integer

Type: null

key_type Required

Key Type

Type of cryptographic key algorithm (e.g., 'RSA', 'EC', 'DSA'). null if key information is unavailable.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

country Required

Country

ISO 3166-1 alpha-2 country code from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

state Required

State

State or province name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

city Required

City

City or locality name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

organization Required

Organization

Organization name from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

organizational_unit Required

Organizational Unit

Organizational unit from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

common Required

Common

Common name (CN) from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

san Required

San

Subject Alternative Names (SAN) from the certificate extension. null if no SAN extension is present.

Any of

• Option 1
• Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

email Required

Email

Email address from the certificate subject. null if not specified.

Any of

• Option 1
• Option 2

Type: string

Type: null

DN Required

Dn

Distinguished Name (DN) of the certificate subject in RFC 2253 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

subject_name_hash Required

Subject Name Hash

Hash of the certificate subject name. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

extensions Required

Extensions

Type: object

X.509 certificate extensions parsed into a dictionary structure.

digest_algorithm Required

Digest Algorithm

Cryptographic hash algorithm used for certificate signing (e.g., 'SHA256'). null if unavailable.

Any of

• Option 1
• Option 2

Type: string

Type: null

lifetime Required

Lifetime

Certificate validity period in seconds. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

from Required

From

Certificate validity start date in ISO 8601 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

until Required

Until

Certificate validity end date in ISO 8601 format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Certificate serial number. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: integer

Type: null

chain Required

Chain

Whether this certificate has an associated certificate chain. null if unavailable.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

fingerprint Required

Fingerprint

SHA-256 fingerprint of the certificate in hexadecimal format. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: string

Type: null

expired Required

Expired

Whether the certificate has expired. null if certificate parsing failed.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

parsed Required

Parsed

Type: boolean

Whether the certificate data was successfully parsed and validated.

REMOVED

CertificateRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: CERTIFICATE_READ