Retrieve an existing trigger :: EVERTRUST documentation

type

string required

The type of notification

Value email

template

object (Email template) required

Where and what to send in the email

from

string required

The sender name of the e-mail

title

string required

The title of the e-mail. This is a customizable template string.

isHtml

boolean required

Whether the e-mail contains HTML code

to

array of string

The recipient(s) of the e-mail

body

string

The body of the e-mail. This is a customizable template string.

id

string (Internal ID) required

Object internal ID

name

string required

Name of the notification

event

string required

Event on which the notification runs

Enum on_crl_gen on_crl_gen_error on_crl_gen_recover on_crl_update on_crl_update_error on_crl_update_recover on_crl_sync on_crl_sync_error on_crl_expiration on_krl_gen on_krl_gen_error on_krl_gen_recover on_krl_sync on_krl_sync_error on_x509_ca_expiration on_ocsp_signer_expiration on_tsa_signer_expiration on_credentials_expiration on_license_expiration on_trigger_error

runPeriod

string

Time period at which the notification needs to run. Can only be defined on expiration and pending events.

triggers

object (TriggersNotificationBase)

onTriggerError

array of string

Notifications to run when this notification fails. Not available if the event for the notification is already on_trigger_error

type

string required

The type of notification

Value rest

method

string required

The HTTP method to use for the request

Enum GET PATCH PUT POST HEAD DELETE

url

string required

The URL to request. This is a template string and can be customized.

authenticationType

string required

The authentication type to use while making the REST call. Is linked to credentials.

Enum noauth basic x509 bearer custom

expectedHttpCodes

array of integer required

The success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.

timeout

string required

Timeout for the HTTP request. Defaults to 5 seconds when omitted.

id

string (Internal ID) required

Object internal ID

name

string required

Name of the notification

event

string required

Event on which the notification runs

Enum on_crl_gen on_crl_gen_error on_crl_gen_recover on_crl_update on_crl_update_error on_crl_update_recover on_crl_sync on_crl_sync_error on_crl_expiration on_krl_gen on_krl_gen_error on_krl_gen_recover on_krl_sync on_krl_sync_error on_x509_ca_expiration on_ocsp_signer_expiration on_tsa_signer_expiration on_credentials_expiration on_license_expiration on_trigger_error

credentials

string

Name of the credentials to use for authentication

headers

array of object (header)

The headers of the request

Array [

name

string

The header name

value

string

The header value. This is a customizable template string.

]

payloadType

string

For UI purposes in order to format the body correctly

Enum json text

payload

string

The body of the request. This is a customizable template string.

proxy

string

Name of a Proxy to use while making the request

runPeriod

string

Time period at which the notification needs to run. Can only be defined on expiration and pending events.

triggers

object (TriggersNotificationBase)

onTriggerError

array of string

Notifications to run when this notification fails. Not available if the event for the notification is already on_trigger_error

storageType

string required

The type of external CRL storage

Value ldap

host

string required

port

integer required

secure

boolean required

disableHostnameValidation

boolean required

baseDN

string required

filter

string required

rlAttribute

string required

Name of the LDAP attribute in which the revocation list is stored

followReferrals

boolean required

id

string (Internal ID) required

Object internal ID

name

string required

Name of the external CRL storage

type

string required

The type of trigger

Value external_rl_storage

proxy

string

Name of the HTTP proxy to use. Can only be set when secure is enabled

timeout

string

Timeout of the LDAP connection. Defaults to 1 minute when omitted

credentials

string

Name of the password credentials used to bind to the LDAP server. Registration accepts a storage without credentials, but publishing then fails

description

string

The description of this external CRL storage

triggers

object (TriggersBase)

onTriggerError

array of string

Notifications to run when this trigger fails

storageType

string required

The type of external CRL storage

Value s3

forcePathStyle

boolean required

bucket

string required

id

string (Internal ID) required

Object internal ID

name

string required

Name of the external CRL storage

type

string required

The type of trigger

Value external_rl_storage

roleArn

string

region

string

proxy

string

timeout

string

Timeout of the S3 requests. Defaults to 5 seconds when omitted

rlAlias

string

Template string defining the object name in the S3 bucket

endpoint

string

checksumMode

string

When the S3 client computes request checksums

Enum when_supported when_required

description

string

The description of this external CRL storage

credentials

string

Name of the credentials to use to authenticate on the storage

triggers

object (TriggersBase)

onTriggerError

array of string

Notifications to run when this trigger fails

storageType

string required

The type of external CRL storage

Value scp

host

string required

Host to push the file to

port

integer required

Port on which to access the host

useCompression

boolean required

Enable compression for the protocol.

path

string required

Template string to define the path on the host machine.

id

string (Internal ID) required

Object internal ID

name

string required

Name of the external CRL storage

type

string required

The type of trigger

Value external_rl_storage

fingerprint

string

SSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.

timeout

string

credentials

string

Name of the password or SSH key credentials used to log in on the host. Registration accepts a storage without credentials, but publishing then fails

description

string

The description of this external CRL storage

triggers

object (TriggersBase)

onTriggerError

array of string

Notifications to run when this trigger fails

storageType

string required

The type of external CRL storage

Value sftp

host

string required

Host to push the file to

port

integer required

Port on which to access the host

useCompression

boolean required

Enable compression for the protocol.

path

string required

Template string to define the path on the host machine.

id

string (Internal ID) required

Object internal ID

name

string required

Name of the external CRL storage

type

string required

The type of trigger

Value external_rl_storage

fingerprint

string

SSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.

timeout

string

credentials

string

Name of the password or SSH key credentials used to log in on the host. Registration accepts a storage without credentials, but publishing then fails

description

string

The description of this external CRL storage

triggers

object (TriggersBase)

onTriggerError

array of string

Notifications to run when this trigger fails

storageType

string required

The type of external CRL storage

Value stream

endpoint

string required

Stream base endpoint

credentials

string required

Name of the password or X.509 credentials used to authenticate on the distant Stream instance

id

string (Internal ID) required

Object internal ID

name

string required

Name of the external CRL storage

type

string required

The type of trigger

Value external_rl_storage

ca

string

Name of the ca on the distant Stream instance. This is a customizable template string. If not defined, the ca name on this Stream instance is given.

timeout

string

Timeout when making the request to stream. Defaults to 5 seconds when omitted

proxy

string

Name of the HTTP proxy to use to reach the distant Stream instance

description

string

The description of this external CRL storage

triggers

object (TriggersBase)

onTriggerError

array of string

Notifications to run when this trigger fails