List Healthcheck Events

List origin health changes.

application/json

Body

result

required

Any of

allOf {2}

array[object (analytics) {4}]

allOf {2}

One of

array[object (analytics) {4}]

object

integer

optional

Default:

origins

array

optional

Example:

[{"address":"198.51.100.4","changed":true,"enabled":true,"failure_reason":"No failures","healthy":true,"ip":"198.51.100.4","name":"some-origin"}]

pool

object

optional

Example:

{"changed":true,"healthy":true,"id":"74bc6a8b9b0dda3d651707a2928bad0c","minimum_origins":1,"name":"some-pool"}

timestamp

string <date-time>

optional

Example:

2014-01-01T05:20:00.12345Z

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

result_info

object

result_info

optional

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

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "id": 1,
            "origins": [
                {
                    "address": "198.51.100.4",
                    "changed": true,
                    "enabled": true,
                    "failure_reason": "No failures",
                    "healthy": true,
                    "ip": "198.51.100.4",
                    "name": "some-origin"
                }
            ],
            "pool": {
                "changed": true,
                "healthy": true,
                "id": "74bc6a8b9b0dda3d651707a2928bad0c",
                "minimum_origins": 1,
                "name": "some-pool"
            },
            "timestamp": "2014-01-01T05:20:00.12345Z"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Healthcheck Events

Request

Request samples

Responses