List origin health changes.
/user/load_balancing_analytics/events
get
Load Balancer Healthcheck Events
load-balancer-healthcheck-events-list-healthcheck-events
nullnull[
{
"in": "query",
"name": "until",
"schema": {
"description": "End date and time of requesting data period in the ISO8601 format.",
"example": "2016-11-11T13:00:00Z",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "pool_name",
"schema": {
"description": "The name for the pool to filter.",
"example": "primary-dc",
"type": "string"
}
},
{
"in": "query",
"name": "origin_healthy",
"schema": {
"default": true,
"description": "If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.",
"example": true,
"type": "boolean"
}
},
{
"in": "query",
"name": "identifier",
"schema": {
"example": "17b5962d775c646f3f9725cbc7a53df4",
"type": "string"
}
},
{
"in": "query",
"name": "since",
"schema": {
"description": "Start date and time of requesting data period in the ISO8601 format.",
"example": "2016-11-11T12:00:00Z",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "origin_name",
"schema": {
"description": "The name for the origin to filter.",
"example": "primary-dc-1",
"type": "string"
}
},
{
"in": "query",
"name": "pool_healthy",
"schema": {
"default": true,
"description": "If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy.",
"example": true,
"type": "boolean"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"id": {
"default": 1,
"type": "integer"
},
"origins": {
"example": [
{
"address": "198.51.100.4",
"changed": true,
"enabled": true,
"failure_reason": "No failures",
"healthy": true,
"ip": "198.51.100.4",
"name": "some-origin"
}
],
"items": {},
"type": "array"
},
"pool": {
"example": {
"changed": true,
"healthy": true,
"id": "74bc6a8b9b0dda3d651707a2928bad0c",
"minimum_origins": 1,
"name": "some-pool"
},
"type": "object"
},
"timestamp": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List Healthcheck Events response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"id": {
"default": 1,
"type": "integer"
},
"origins": {
"example": [
{
"address": "198.51.100.4",
"changed": true,
"enabled": true,
"failure_reason": "No failures",
"healthy": true,
"ip": "198.51.100.4",
"name": "some-origin"
}
],
"items": {},
"type": "array"
},
"pool": {
"example": {
"changed": true,
"healthy": true,
"id": "74bc6a8b9b0dda3d651707a2928bad0c",
"minimum_origins": 1,
"name": "some-pool"
},
"type": "object"
},
"timestamp": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List Healthcheck Events response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]