load-balancing_health_details

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-load-balancing-health-details-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/load-balancing_health_details",
  "title": "load-balancing_health_details",
  "allOf": [
    {
      "$ref": "#/components/schemas/load-balancing_api-response-single"
    },
    {
      "properties": {
        "result": {
          "description": "A list of regions from which to run health checks. Null means every Cloudflare data center.",
          "example": {
            "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
            "pop_health": {
              "Amsterdam, NL": {
                "healthy": true,
                "origins": [
                  {
                    "2001:DB8::5": {
                      "failure_reason": "No failures",
                      "healthy": true,
                      "response_code": 401,
                      "rtt": "12.1ms"
                    }
                  }
                ]
              }
            }
          },
          "properties": {
            "pool_id": {
              "description": "Pool ID",
              "example": "17b5962d775c646f3f9725cbc7a53df4",
              "type": "string"
            },
            "pop_health": {
              "description": "List of regions and associated health status.",
              "properties": {
                "healthy": {
                  "description": "Whether health check in region is healthy.",
                  "example": true,
                  "type": "boolean"
                },
                "origins": {
                  "items": {
                    "$ref": "#/components/schemas/load-balancing_origin-health"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        }
      }
    }
  ]
}