Skip to main content

JSON objects

SearchCriteria

The name, operator and value fields must be used together.
The junction and elements fields must be used together and are used to create more complex queries.

NameRequiredTypeDefault valueDescription
nameNoStringThe Event field you want to search for.
Allowed values : action, certificateOrganization, context, creatorIpv4, creatorIpv6, creatorLogin, domain, state, user, zone
Example: domain
operatorNoStringEQUALSThe search operator.
Allowed values : EQUALS, NOT_EQUALS, EQUALS_CASE_INSENSITIVE, STARTS_WITH, ENDS_WITH, CONTAINS, IN, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS
valueNoString, String[], Integer, Integer[]The value of the name field.
Examples :
  • example.com
  • ['example.com', 'example.net']
junctionNoStringANDLogical operator used with the elements field.
Allowed values : AND, OR
elementsNoList of SearchCriteriaA list of SearchCriteria which will be used with the junction logical operator

SearchResult

NameTypeDefault valueDescription
totalIntegerTotal number of events matching the search criteria
limitInteger100Number of events returned
offsetInteger0Offset used
resultsList of EventList of events matching the search criteria

Event

NameTypeDefault valueDescription
idStringEvent identifier
dateString100Datetime of the event
contextStringContext of the event
Possible values are :
  • ssl
  • domain
  • dns
  • contact
  • user
  • api
  • registry
  • registry-lock
  • twoFactorAuthentication
  • ged
  • zone
  • defaultZone
  • dnssec
  • dnssecKey
  • httpRedirection
  • failover
  • access
  • role
  • token
  • gluerecord
  • export
actionStringAction of the event
Possible values are :
  • activation
  • connection
  • contractValidation
  • creation
  • deactivation
  • deletion
  • download
  • lock
  • transfer
  • transferOut
  • unlock
  • update
  • expiration
stateStringState of the event
Possible values are :
  • active
  • delete
  • failure
  • inactive
  • pending
  • success
customerIdIntegerThe customer identifier of the event creator
creatorLoginStringThe login of the event creator
creatorIpv4StringIPv4 of the event creator
creatorIpv6StringIPv6 of the event creator
userStringThe user targeted by the event
domainStringThe domain targeted by the event
zoneStringThe DNS zone targeted by the event
certificateOrganizationStringThe certificate organization targeted by the event
payloadObjectPayload data of the event