WebSiteCreate

Request body for creating a new web site.

DatacenterEnterpriseInfrastructureMicrosoftOperating SystemServer ManagementWindows ServerWindows Server 2025

Properties

Name Type Description
name string The name of the web site to create.
physical_path string The physical file system path for the web site root directory. The directory must exist.
bindings array The bindings for the web site.
application_pool object Optional application pool assignment.
server_auto_start boolean Whether the web site starts automatically when IIS starts.
enabled_protocols string The protocols enabled for this web site.
View JSON Schema on GitHub

JSON Schema

microsoft-windows-server-websitecreate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebSiteCreate",
  "title": "WebSiteCreate",
  "type": "object",
  "description": "Request body for creating a new web site.",
  "required": [
    "name",
    "physical_path",
    "bindings"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the web site to create.",
      "examples": [
        "Demonstration Site"
      ]
    },
    "physical_path": {
      "type": "string",
      "description": "The physical file system path for the web site root directory. The directory must exist.",
      "examples": [
        "C:\\inetpub\\wwwroot\\DemonstrationSite"
      ]
    },
    "bindings": {
      "type": "array",
      "description": "The bindings for the web site.",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/Binding"
      },
      "example": []
    },
    "application_pool": {
      "type": "object",
      "description": "Optional application pool assignment.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the application pool."
        }
      },
      "example": "example_value"
    },
    "server_auto_start": {
      "type": "boolean",
      "description": "Whether the web site starts automatically when IIS starts.",
      "default": true,
      "example": true
    },
    "enabled_protocols": {
      "type": "string",
      "description": "The protocols enabled for this web site.",
      "default": "http",
      "example": "example_value"
    }
  }
}