Skip to main content
Version: 4.42

API reference — Querying events

Overview

The Administration API exposes three types of events you can query and export:

  • Certificate events: record each certificate use (signing, authentication, operations denied by policy).
  • System events: record actions performed in the admin console (configuration changes, user management, policy creation).
  • HA events: record high-availability cluster activity.

Before you start

Before testing these methods, you need to set up SoapUI.

important

The <!--Optional:--> comments that appear in SOAP requests are generated automatically and may incorrectly mark required fields as optional.

This documentation explicitly states which fields are required or optional. Always trust this documentation.

Certificate events

ListEvents

Returns the list of certificate usage events matching the specified parameters, ordered by date.

NameTypeRequiredDescription
filterstringNoText that results must contain. If empty, returns all events.
numBlockintegerYesResult block number to return (pagination). The first block is 0.
orderColumnstringYesSort column: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_CONTEXT, ORDER_BY_CERTIFICATE, ORDER_BY_DESCRIPTION, ORDER_BY_URL.
orderTypestringYesSort direction: ORDER_ASCENDING, ORDER_DESCENDING.
filterTypestringYesFilters by event type: NO_FILTER, FILTER_BY_SECURITY (session), FILTER_BY_CERTIFICATE_OPERATION (certificate use), FILTER_BY_PERMISSION_DENIED, FILTER_BY_PERMISSION_ALLOWED, FILTER_BY_CERT_LIFECYCLE.
dateFilterTypestringYesPredefined date filter: NO_DATE_FILTER, DATE_FILTER_TODAY, DATE_FILTER_THIS_WEEK, DATE_FILTER_THIS_MONTH, DATE_FILTER_LAST_THREE_MONTHS, DATE_FILTER_LAST_SIX_MONTHS, DATE_FILTER_THIS_YEAR, DATE_FILTER_CUSTOM_FILTER. Use DATE_FILTER_CUSTOM_FILTER to specify a range with from and to.
fromdatetimeNoStart date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
todatetimeNoEnd date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>DATE_FILTER_TODAY</urn:dateFilterType>
</urn:ListEvents>
</soap:Body>
</soap:Envelope>

System events

ListSystemEvents

Returns the list of admin console activity events matching the specified parameters, ordered by date.

NameTypeRequiredDescription
filterstringNoText that results must contain. If empty, returns all events.
numBlockintegerYesResult block number to return (pagination). The first block is 0.
orderColumnstringYesSort column: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringYesSort direction: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringYesPredefined date filter. Same values as in ListEvents.
fromdatetimeNoStart date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
todatetimeNoEnd date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListSystemEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>DATE_FILTER_THIS_WEEK</urn:dateFilterType>
</urn:ListSystemEvents>
</soap:Body>
</soap:Envelope>

HA events

ListHAEvents

Returns the list of high-availability cluster events matching the specified parameters, ordered by date. Returns SystemEventView objects in the same format as ListSystemEvents.

NameTypeRequiredDescription
filterstringNoText that results must contain. If empty, returns all events.
numBlockintegerYesResult block number to return (pagination). The first block is 0.
orderColumnstringYesSort column: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringYesSort direction: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringYesPredefined date filter. Same values as in ListEvents.
fromdatetimeNoStart date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
todatetimeNoEnd date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListHAEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</urn:ListHAEvents>
</soap:Body>
</soap:Envelope>

Export events

DownloadCSVEvents

Downloads a CSV file with the certificate events matching the specified parameters. Parameters go in the SOAP header, not the body.

NameTypeRequiredDescription
basicFilter (header)stringNoText that results must contain. If empty, includes all events.
filterType (header)stringYesFilters by event type. Same values as in ListEvents.
dateFilterType (header)stringYesPredefined date filter. Same values as in ListEvents.
from (header)datetimeNoStart date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
to (header)datetimeNoEnd date of the custom range. Only used when dateFilterType is DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header>
<urn:basicFilter></urn:basicFilter>
<urn:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</soap:Header>
<soap:Body>
<urn:CSVFilteredWithDatesMessage/>
</soap:Body>
</soap:Envelope>

Was this page helpful?