List events

This endpoint allows you to search for events that took place within our applications.
Many results can be returned, so a pagination system is provided with the limit and offset parameters.
You can search for events that took place on a particular domain, or search for events issued by a specific user.

Endpoint

POST /event/v1/search

Parameters

Name	Location	Required	Type	Default value	Description
queryParameters	Body	No	SearchCriteria[]		List of search criteria
limit	Body	No	Integer	100	Number of events to return (max 500)
offset	Body	No	Integer	0	Offset used
customerId	Body	No	Integer	Connected user's customer ID	Search for events associated to this customer. By default, the id of the customer associated to the connected user will be used
includeCustomerChildrenEvents	Body	No	Boolean	true	Search for events associated to subsidiaries
startedAt	Body	No	String		Search for events emitted after this datetime (UTC). Format : yyyy-MM-dd HH:mm:ss
endedAt	Body	No	String		Search for events emitted before this datetime (UTC). Format : yyyy-MM-dd HH:mm:ss

Response

A SearchResult object.

Example Request

POST /event/v1/search
Content-Type: application/json

Body

{
    "queryParameters": [
        {
            "name": "zone",
            "operator": "STARTS_WITH",
            "value": "example."
        },
        {
            "name": "creatorLogin",
            "value": "jo.doe"
        },
        {
            "junction": "OR",
            "elements": [
                {
                    "name": "creatorIpv4",
                    "operator": "IN",
                    "value": ["1.2.3.4", "5.6.7.8"]
                },
                {
                    "name": "creatorIpv6",
                    "operator": "IN",
                    "value": ["::ffff:102:304", "::ffff:506:708"]
                }
            ]
        }
    ],
    "limit": 10,
    "startedAt": "2023-05-01 00:00:00",
    "endedAt": "2023-05-31 00:00:00"
}

Example Response

{
    "message": "OK",
    "data": {
        "limit": 10,
        "offset": 0,
        "total": 3,
        "results": [
            {
                "id": "c5d0f61e-a68c-4dda-836e-2898823b695f",
                "date": "2023-05-16 09:48:51",
                "context": "zone",
                "action": "update",
                "state": "success",
                "customerId": 10,
                "creatorLogin": "jo.doe",
                "creatorIpv4": "1.2.3.4",
                "domain": "example.com",
                "zone": "example.com",
                "payload": {
                    "records": {
                        "old": [
                            {
                                "data": "old.fqdn.com.",
                                "name": "example",
                                "type": "CNAME"
                            }
                        ]
                    }
                }
            },
            {
                "id": "86bbbbda-9ac7-4958-8039-dd67c210f16c",
                "date": "2023-04-11 13:50:00",
                "context": "zone",
                "action": "update",
                "state": "success",
                "customerId": 10,
                "creatorLogin": "jo.doe",
                "creatorIpv6": "::ffff:102:304",
                "domain": "example.net",
                "zone": "example.net",
                "payload": {
                    "records": {
                        "new": [
                            {
                                "data": "10.20.30.40",
                                "name": "new-service",
                                "type": "A"
                            },
                            {
                                "data": "10.20.30.41",
                                "name": "new-service",
                                "type": "A"
                            }
                        ]
                    }
                }
            },
            {
                "id": "642b6df5-2003-4d67-ab46-bdeb81cddd04",
                "date": "2023-03-07 10:14:25",
                "context": "zone",
                "action": "update",
                "state": "success",
                "customerId": 10,
                "creatorLogin": "jo.doe",
                "creatorIpv4": "5.6.7.8",
                "domain": "example.net",
                "zone": "example.net",
                "payload": {
                    "records": {
                        "new": [
                            {
                                "data": "new-fqdn.service.com.",
                                "name": "service",
                                "type": "CNAME",
                                "ttl": 300
                            }
                        ],
                        "old": [
                            {
                                "data": "fqdn.service.com.",
                                "name": "service",
                                "type": "CNAME"
                            }
                        ]
                    }
                }
            }
        ]
    }
}