HTTPService

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/traefik/main/json-schema/traefik-httpservice-schema.json",
  "title": "HTTPService",
  "description": "An HTTP service representing one or more backend servers.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/traefik-http-api-openapi.yml#/components/schemas/HTTPService",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the service in name@provider format."
    },
    "type": {
      "type": "string",
      "description": "The type of service (loadBalancer, weighted, mirroring)."
    },
    "status": {
      "type": "string",
      "description": "The current status of the service.",
      "enum": [
        "enabled",
        "disabled",
        "warning"
      ]
    },
    "provider": {
      "type": "string",
      "description": "The configuration provider that created this service."
    },
    "loadBalancer": {
      "type": "object",
      "description": "Load balancer configuration with backend servers.",
      "properties": {
        "servers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "description": "The URL of the backend server."
              }
            }
          }
        },
        "passHostHeader": {
          "type": "boolean",
          "description": "Whether to pass the host header to backends."
        },
        "healthCheck": {
          "type": "object",
          "description": "Health check configuration for the backend servers.",
          "properties": {
            "scheme": {
              "type": "string"
            },
            "path": {
              "type": "string"
            },
            "port": {
              "type": "integer"
            },
            "interval": {
              "type": "string"
            },
            "timeout": {
              "type": "string"
            }
          }
        }
      }
    },
    "serverStatus": {
      "type": "object",
      "description": "Map of server URLs to their current health status.",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}