List History

Gets a list of history records for notifications sent to an account. The records are displayed for last x number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).

application/json

Body

result

required

Any of

allOf {2}

array[object (history) {8}]

allOf {2}

One of

array[object (history) {8}]

object

Example:

[{"alert_body":"SSL certificate has expired","alert_type":"universal_ssl_event_type","description":"Universal Certificate validation status, issuance, renewal, and expiration notices.","id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","mechanism":"test@example.com","mechanism_type":"email","name":"SSL Notification Event Policy","sent":"2021-10-08T17:52:17.571336Z"}]

alert_body

string

alert_body

optional

Message body included in the notification sent.

Example:

SSL certificate has expired

alert_type

string

schemas-alert_type

optional

Type of notification that has been dispatched.

Example:

universal_ssl_event_type

description

string

history_components-schemas-description

optional

Description of the notification policy (if present).

Example:

Universal Certificate validation status, issuance, renewal, and expiration notices

string

uuid

read-onlyoptional

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

mechanism

string

mechanism

optional

The mechanism to which the notification has been dispatched.

Example:

test@example.com

mechanism_type

enum<string>

mechanism_type

optional

The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.

Allowed values:

emailpagerdutywebhook

Example:

name

string

history_components-schemas-name

optional

Name of the policy.

Example:

SSL Notification Event Policy

sent

string <date-time>

sent

optional

Timestamp of when the notification was dispatched in ISO 8601 format.

Example:

2021-10-08T17:52:17.571336Z

result_info

object

result_info

optional

Example:

{"count":1,"page":1,"per_page":20}

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "alert_body": "SSL certificate has expired",
            "alert_type": "universal_ssl_event_type",
            "description": "Universal Certificate validation status, issuance, renewal, and expiration notices.",
            "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            "mechanism": "test@example.com",
            "mechanism_type": "email",
            "name": "SSL Notification Event Policy",
            "sent": "2021-10-08T17:52:17.571336Z"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses