WebSiteUpdate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-windows-server/json-schema/microsoft-windows-server-web-site-update-schema.json",
  "title": "WebSiteUpdate",
  "description": "Request body for updating a web site. Only include properties that should be changed. Note that list properties like bindings replace the entire list.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-windows-server-websites-api-openapi.yml#/components/schemas/WebSiteUpdate",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the web site."
    },
    "physical_path": {
      "type": "string",
      "description": "The physical file system path for the web site root."
    },
    "bindings": {
      "type": "array",
      "description": "The full list of desired bindings. Existing bindings not included in this list will be removed.",
      "items": {
        "$ref": "#/$defs/Binding"
      }
    },
    "application_pool": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "server_auto_start": {
      "type": "boolean"
    },
    "enabled_protocols": {
      "type": "string"
    },
    "limits": {
      "$ref": "#/$defs/WebSiteLimits"
    }
  },
  "$defs": {
    "Binding": {
      "type": "object",
      "description": "Defines the protocol, IP address, port, and optional hostname that a web site listens on. The binding_information property format is '{ip_address}:{port}:{hostname}' for HTTP and HTTPS protocols.",
      "required": [
        "protocol"
      ],
      "properties": {
        "protocol": {
          "type": "string",
          "description": "The protocol for this binding (e.g., http, https, net.tcp)."
        },
        "binding_information": {
          "type": "string",
          "description": "Combined binding string in the format '{ip_address}:{port}:{hostname}'."
        },
        "ip_address": {
          "type": "string",
          "description": "The IP address to bind to. Use '*' for all addresses."
        },
        "port": {
          "type": "integer",
          "description": "The port number to listen on.",
          "minimum": 1,
          "maximum": 65535
        },
        "hostname": {
          "type": "string",
          "description": "The hostname for host header-based routing."
        },
        "certificate": {
          "$ref": "#/$defs/Certificate"
        },
        "require_sni": {
          "type": "boolean",
          "description": "Whether Server Name Indication (SNI) is required for this binding.",
          "default": false
        }
      }
    },
    "Certificate": {
      "type": "object",
      "description": "An SSL/TLS certificate associated with an HTTPS binding.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The friendly name of the certificate."
        },
        "id": {
          "type": "string",
          "description": "The unique identifier of the certificate resource."
        },
        "issued_by": {
          "type": "string",
          "description": "The certificate issuer distinguished name."
        },
        "subject": {
          "type": "string",
          "description": "The certificate subject distinguished name."
        },
        "thumbprint": {
          "type": "string",
          "description": "The SHA-1 thumbprint of the certificate."
        },
        "valid_to": {
          "type": "string",
          "format": "date-time",
          "description": "The expiration date of the certificate."
        }
      }
    },
    "WebSiteLimits": {
      "type": "object",
      "description": "Resource limits for the web site.",
      "properties": {
        "connection_timeout": {
          "type": "integer",
          "description": "The connection timeout in seconds.",
          "default": 120
        },
        "max_bandwidth": {
          "type": "integer",
          "description": "The maximum bandwidth in bytes per second.",
          "format": "int64",
          "default": 4294967295
        },
        "max_connections": {
          "type": "integer",
          "description": "The maximum number of concurrent connections.",
          "format": "int64",
          "default": 4294967295
        },
        "max_url_segments": {
          "type": "integer",
          "description": "The maximum number of URL segments allowed.",
          "default": 32
        }
      }
    }
  }
}