IIS Administration

AllowedServerVariables

Updates the allowed server variables settings.

Request

PATCH /api/webserver/url-rewrite/allowed-server-variables/{id}

Properties

    1. id (required)
    2. string

    The id for the allowed server variables resource

    1. feature (required)

    AllowedServerVariablesSection

    view child properties

      1. id
      2. string
      1. scope
      2. string
      1. entries
      2. array
      1. metadata
      2. object

      metadata

      view child properties

        1. is_local
        2. boolean
        1. is_locked
        2. boolean
        1. override_mode
        2. string
        1. override_mode_effective
        2. string
      1. url_rewrite
      2. object

      UrlRewrite

      view child properties

        1. id
        2. string

        Unique identifier for the Url Rewrite feature.

        1. scope
        2. string

        The location in the configuration system that this resource reflects.

        1. website
        2. object

        WebSite

        view child properties

          1. id
          2. string

          A unique identifier for the web site.

          1. name
          2. string

          The name of the web site.

          1. physical_path
          2. string

          The location of the web site's root directory in the file system

          1. key
          2. number

          The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

          1. server_auto_start
          2. boolean

          A value indicating whether the web site should automatically start.

          1. enabled_protocols
          2. string

          Communication protocols that are enabled for the web site.

          1. limits
          2. object

          view child properties

            1. connection_timeout
            2. integer

            The period of time IIS waits before it considers a connection inactive.

            1. max_bandwidth
            2. integer

            Maximum network bandwidth in bytes per second.

            1. max_connections
            2. integer

            Maximum number of simultaneous connections allowed for a web site.

            1. max_url_segments
            2. integer

            Maximum number of URL segments allowed in any given request to the web site.

          1. bindings
          2. array

          WebSiteBinding

          view child properties

            1. protocol
            2. string

            The protocol the binding will listen for.

            1. binding_information
            2. string

            A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

            1. ip_address
            2. string

            The IP address the binding will listen for.

            1. port
            2. number

            The port the binding will listen on.

            1. hostname
            2. string

            The hostname that will resolve to the binding.

            1. certificate
            2. object

            Certificate

            view child properties

              1. alias
              2. string
              1. id
              2. string
              1. issued_by
              2. string
              1. subject
              2. string
              1. thumbprint
              2. string
              1. signature_algorithm
              2. string
              1. valid_from
              2. string
              1. valid_to
              2. string
              1. version
              2. number
              1. intended_purposes
              2. array
              1. private_key
              2. object

              view child properties

                1. exportable
                2. boolean
              1. subject_alternative_names
              2. array
              1. store
              2. object

              CertificateStore

              view child properties

                1. name
                2. string
                1. id
                2. string
                1. claims
                2. array
                1. _links
                2. object
              1. _links
              2. object
            1. require_sni
            2. boolean

            Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

          1. status
          2. string

          Status indicating whether or not the site is capable of handling requests.

          1. application_pool
          2. object

          ApplicationPool

          view child properties

            1. name
            2. string

            The name of the application pool.

            1. id
            2. string

            A unique identifier for the application pool.

            1. status
            2. string

            The run-time state of the current application pool.

            1. auto_start
            2. boolean

            A value indicating whether the current application pool starts automatically when created or when IIS starts.

            1. pipeline_mode
            2. string

            This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

            1. managed_runtime_version
            2. string

            The version of the .NET Framework that is used for managed applications in the current application pool.

            1. queue_length
            2. number

            The maximum number of requests to queue before rejecting additional requests.

            1. cpu
            2. object

            CPU usage parameters for the current application pool.

            view child properties

              1. limit
              2. number

              The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

              1. limit_interval
              2. number

              A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

              1. action
              2. string

              The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

              1. processor_affinity_enabled
              2. boolean

              This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

              1. processor_affinity_mask32
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

              1. processor_affinity_mask64
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. process_model
            2. object

            view child properties

              1. idle_timeout
              2. number

              The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

              1. idle_timeout_action
              2. string

              The action to perform if a worker process is shut down from an idle timeout.

              1. max_processes
              2. number

              The number of processes associated with the current application pool. The default is 1.

              1. pinging_enabled
              2. boolean

              The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

              1. ping_interval
              2. number

              A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

              1. ping_response_time
              2. number

              A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

              1. shutdown_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

              1. startup_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

            1. identity
            2. object

            view child properties

              1. identity_type
              2. string

              The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

              1. username
              2. string

              The user name associated with the security identity under which the application pool runs.

              1. load_user_profile
              2. boolean

              true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

              1. password
              2. string

              A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

            1. recycling
            2. object

            view child properties

              1. disable_overlapped_recycle
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

              1. disable_recycle_on_config_change
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

              1. log_events
              2. object

              This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

              view child properties

                1. time
                2. boolean
                1. requeuessts
                2. boolean
                1. schedule
                2. boolean
                1. memory
                2. boolean
                1. isapi_unhealthy
                2. boolean
                1. on_demand
                2. boolean
                1. config_change
                2. boolean
                1. private_memory
                2. boolean
              1. periodic_restart
              2. object

              An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

              view child properties

                1. time_interval
                2. number

                A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

                1. private_memory
                2. number

                The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. request_limit
                2. number

                The number of requests that a worker process should process before it is recycled.

                1. virtual_memory
                2. number

                The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. schedule
                2. array

                A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

            1. rapid_fail_protection
            2. object

            view child properties

              1. enabled
              2. boolean

              true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

              1. load_balancer_capabilities
              2. string

              This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

              1. interval
              2. number

              A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

              1. max_crashes
              2. number

              The maximum number of application pool failures allowed. The default is 5.

              1. auto_shutdown_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

              1. auto_shutdown_params
              2. string

              The command-line parameters for the executable specified by the auto_shutdown_exe property.

            1. process_orphaning
            2. object

            view child properties

              1. enabled
              2. boolean

              This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

              1. orphan_action_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

              1. orphan_action_params
              2. string

              Command-line parameters for the executable specified by the orphan_action_exe property.

            1. _links
            2. object
          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

ApplicationPool

Lists the application pools on the web server.

Request

GET /api/webserver/application-pools[?fields]

Properties

    1. fields
    2. string

    Select additional or specific fields for app pool object.

Returns

HTTP RESPONSE CODES
    1. 200

    An object containing the array of application pools.

    1. default

    Error.

Create an application pool

Request

POST /api/webserver/application-pools

Properties

    1. pool (required)

    ApplicationPool

    view child properties

      1. name
      2. string

      The name of the application pool.

      1. id
      2. string

      A unique identifier for the application pool.

      1. status
      2. string

      The run-time state of the current application pool.

      1. auto_start
      2. boolean

      A value indicating whether the current application pool starts automatically when created or when IIS starts.

      1. pipeline_mode
      2. string

      This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

      1. managed_runtime_version
      2. string

      The version of the .NET Framework that is used for managed applications in the current application pool.

      1. queue_length
      2. number

      The maximum number of requests to queue before rejecting additional requests.

      1. cpu
      2. object

      CPU usage parameters for the current application pool.

      view child properties

        1. limit
        2. number

        The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

        1. limit_interval
        2. number

        A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

        1. action
        2. string

        The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

        1. processor_affinity_enabled
        2. boolean

        This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

        1. processor_affinity_mask32
        2. string

        A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

        1. processor_affinity_mask64
        2. string

        A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

      1. process_model
      2. object

      view child properties

        1. idle_timeout
        2. number

        The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

        1. idle_timeout_action
        2. string

        The action to perform if a worker process is shut down from an idle timeout.

        1. max_processes
        2. number

        The number of processes associated with the current application pool. The default is 1.

        1. pinging_enabled
        2. boolean

        The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

        1. ping_interval
        2. number

        A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

        1. ping_response_time
        2. number

        A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

        1. shutdown_time_limit
        2. number

        A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

        1. startup_time_limit
        2. number

        A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

      1. identity
      2. object

      view child properties

        1. identity_type
        2. string

        The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

        1. username
        2. string

        The user name associated with the security identity under which the application pool runs.

        1. load_user_profile
        2. boolean

        true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

        1. password
        2. string

        A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

      1. recycling
      2. object

      view child properties

        1. disable_overlapped_recycle
        2. boolean

        This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

        1. disable_recycle_on_config_change
        2. boolean

        This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

        1. log_events
        2. object

        This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

        view child properties

          1. time
          2. boolean
          1. requeuessts
          2. boolean
          1. schedule
          2. boolean
          1. memory
          2. boolean
          1. isapi_unhealthy
          2. boolean
          1. on_demand
          2. boolean
          1. config_change
          2. boolean
          1. private_memory
          2. boolean
        1. periodic_restart
        2. object

        An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

        view child properties

          1. time_interval
          2. number

          A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

          1. private_memory
          2. number

          The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

          1. request_limit
          2. number

          The number of requests that a worker process should process before it is recycled.

          1. virtual_memory
          2. number

          The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

          1. schedule
          2. array

          A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

      1. rapid_fail_protection
      2. object

      view child properties

        1. enabled
        2. boolean

        true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

        1. load_balancer_capabilities
        2. string

        This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

        1. interval
        2. number

        A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

        1. max_crashes
        2. number

        The maximum number of application pool failures allowed. The default is 5.

        1. auto_shutdown_exe
        2. string

        This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

        1. auto_shutdown_params
        2. string

        The command-line parameters for the executable specified by the auto_shutdown_exe property.

      1. process_orphaning
      2. object

      view child properties

        1. enabled
        2. boolean

        This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

        1. orphan_action_exe
        2. string

        This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

        1. orphan_action_params
        2. string

        Command-line parameters for the executable specified by the orphan_action_exe property.

      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

View the settings for a specific application pool.

Request

GET /api/webserver/application-pools/{id}

Properties

    1. id (required)
    2. string

    The id for the application pool

Returns

HTTP RESPONSE CODES
    1. 200

    The application pool with the specified id.

    1. 404

    Cannot find the resource.

    1. default

    Error.

Update the application pool with the specified id.

Request

PATCH /api/webserver/application-pools/{id}

Properties

    1. id (required)
    2. string

    The id for the application pool

    1. pool (required)

    ApplicationPool

    view child properties

      1. name
      2. string

      The name of the application pool.

      1. id
      2. string

      A unique identifier for the application pool.

      1. status
      2. string

      The run-time state of the current application pool.

      1. auto_start
      2. boolean

      A value indicating whether the current application pool starts automatically when created or when IIS starts.

      1. pipeline_mode
      2. string

      This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

      1. managed_runtime_version
      2. string

      The version of the .NET Framework that is used for managed applications in the current application pool.

      1. queue_length
      2. number

      The maximum number of requests to queue before rejecting additional requests.

      1. cpu
      2. object

      CPU usage parameters for the current application pool.

      view child properties

        1. limit
        2. number

        The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

        1. limit_interval
        2. number

        A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

        1. action
        2. string

        The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

        1. processor_affinity_enabled
        2. boolean

        This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

        1. processor_affinity_mask32
        2. string

        A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

        1. processor_affinity_mask64
        2. string

        A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

      1. process_model
      2. object

      view child properties

        1. idle_timeout
        2. number

        The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

        1. idle_timeout_action
        2. string

        The action to perform if a worker process is shut down from an idle timeout.

        1. max_processes
        2. number

        The number of processes associated with the current application pool. The default is 1.

        1. pinging_enabled
        2. boolean

        The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

        1. ping_interval
        2. number

        A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

        1. ping_response_time
        2. number

        A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

        1. shutdown_time_limit
        2. number

        A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

        1. startup_time_limit
        2. number

        A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

      1. identity
      2. object

      view child properties

        1. identity_type
        2. string

        The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

        1. username
        2. string

        The user name associated with the security identity under which the application pool runs.

        1. load_user_profile
        2. boolean

        true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

        1. password
        2. string

        A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

      1. recycling
      2. object

      view child properties

        1. disable_overlapped_recycle
        2. boolean

        This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

        1. disable_recycle_on_config_change
        2. boolean

        This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

        1. log_events
        2. object

        This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

        view child properties

          1. time
          2. boolean
          1. requeuessts
          2. boolean
          1. schedule
          2. boolean
          1. memory
          2. boolean
          1. isapi_unhealthy
          2. boolean
          1. on_demand
          2. boolean
          1. config_change
          2. boolean
          1. private_memory
          2. boolean
        1. periodic_restart
        2. object

        An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

        view child properties

          1. time_interval
          2. number

          A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

          1. private_memory
          2. number

          The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

          1. request_limit
          2. number

          The number of requests that a worker process should process before it is recycled.

          1. virtual_memory
          2. number

          The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

          1. schedule
          2. array

          A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

      1. rapid_fail_protection
      2. object

      view child properties

        1. enabled
        2. boolean

        true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

        1. load_balancer_capabilities
        2. string

        This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

        1. interval
        2. number

        A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

        1. max_crashes
        2. number

        The maximum number of application pool failures allowed. The default is 5.

        1. auto_shutdown_exe
        2. string

        This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

        1. auto_shutdown_params
        2. string

        The command-line parameters for the executable specified by the auto_shutdown_exe property.

      1. process_orphaning
      2. object

      view child properties

        1. enabled
        2. boolean

        This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

        1. orphan_action_exe
        2. string

        This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

        1. orphan_action_params
        2. string

        Command-line parameters for the executable specified by the orphan_action_exe property.

      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 400

    Argument error.

    1. 404

    Cannot find the resource.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

Lists performance and monitoring snapshots for application pools on the web server.

Request

GET /api/webserver/application-pools/monitoring[?fields]

Properties

    1. fields
    2. string

    Select specific fields for the application pools.

Returns

HTTP RESPONSE CODES
    1. 200

    An object containing the array of application pools.

    1. default

    Error.

View the performance and monitoring snapshot for a specific application pool.

Request

GET /api/webserver/application-pools/monitoring/{id}

Properties

    1. id (required)
    2. string

    The id for the application pool

Returns

HTTP RESPONSE CODES
    1. 200

    The performance and monitoring snapshot of thew application pool with the specified id.

    1. 404

    Cannot find the resource.

    1. default

    Error.

Applications

Returns a list of applications.

Request

GET /api/webserver/webapps[?fields&application_pool.id&website.id]

Properties

    1. fields
    2. string

    Select additional or specific fields for the applications.

    1. application_pool.id
    2. string

    Retrieve applications for the application pool with the given id.

    1. website.id
    2. string

    Retrieve applications for the web site with the given id.

Returns

HTTP RESPONSE CODES
    1. 200

    An object containing the array of applications.

    1. default

    Error.

Creates a application for the web site specified in the request body.

Request

POST /api/webserver/webapps

Properties

    1. webapp (required)

    Application

    view child properties

      1. location
      2. string

      The full path of the application beginning with the web site name.

      1. id
      2. string

      A unique identifier for the application.

      1. path
      2. string

      The path of the application. This path is used to resolve the application in the URL relative to the root of the web site.

      1. physical_path
      2. string

      The location of the application's root directory in the file system

      1. enabled_protocols
      2. string

      Communication protocols that are enabled for the application.

      1. website
      2. object

      The web site that the application belongs to.

      WebSite

      view child properties

        1. id
        2. string

        A unique identifier for the web site.

        1. name
        2. string

        The name of the web site.

        1. physical_path
        2. string

        The location of the web site's root directory in the file system

        1. key
        2. number

        The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

        1. server_auto_start
        2. boolean

        A value indicating whether the web site should automatically start.

        1. enabled_protocols
        2. string

        Communication protocols that are enabled for the web site.

        1. limits
        2. object

        view child properties

          1. connection_timeout
          2. integer

          The period of time IIS waits before it considers a connection inactive.

          1. max_bandwidth
          2. integer

          Maximum network bandwidth in bytes per second.

          1. max_connections
          2. integer

          Maximum number of simultaneous connections allowed for a web site.

          1. max_url_segments
          2. integer

          Maximum number of URL segments allowed in any given request to the web site.

        1. bindings
        2. array

        WebSiteBinding

        view child properties

          1. protocol
          2. string

          The protocol the binding will listen for.

          1. binding_information
          2. string

          A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

          1. ip_address
          2. string

          The IP address the binding will listen for.

          1. port
          2. number

          The port the binding will listen on.

          1. hostname
          2. string

          The hostname that will resolve to the binding.

          1. certificate
          2. object

          Certificate

          view child properties

            1. alias
            2. string
            1. id
            2. string
            1. issued_by
            2. string
            1. subject
            2. string
            1. thumbprint
            2. string
            1. signature_algorithm
            2. string
            1. valid_from
            2. string
            1. valid_to
            2. string
            1. version
            2. number
            1. intended_purposes
            2. array
            1. private_key
            2. object

            view child properties

              1. exportable
              2. boolean
            1. subject_alternative_names
            2. array
            1. store
            2. object

            CertificateStore

            view child properties

              1. name
              2. string
              1. id
              2. string
              1. claims
              2. array
              1. _links
              2. object
            1. _links
            2. object
          1. require_sni
          2. boolean

          Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

        1. status
        2. string

        Status indicating whether or not the site is capable of handling requests.

        1. application_pool
        2. object

        ApplicationPool

        view child properties

          1. name
          2. string

          The name of the application pool.

          1. id
          2. string

          A unique identifier for the application pool.

          1. status
          2. string

          The run-time state of the current application pool.

          1. auto_start
          2. boolean

          A value indicating whether the current application pool starts automatically when created or when IIS starts.

          1. pipeline_mode
          2. string

          This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

          1. managed_runtime_version
          2. string

          The version of the .NET Framework that is used for managed applications in the current application pool.

          1. queue_length
          2. number

          The maximum number of requests to queue before rejecting additional requests.

          1. cpu
          2. object

          CPU usage parameters for the current application pool.

          view child properties

            1. limit
            2. number

            The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

            1. limit_interval
            2. number

            A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

            1. action
            2. string

            The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

            1. processor_affinity_enabled
            2. boolean

            This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

            1. processor_affinity_mask32
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. processor_affinity_mask64
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

          1. process_model
          2. object

          view child properties

            1. idle_timeout
            2. number

            The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

            1. idle_timeout_action
            2. string

            The action to perform if a worker process is shut down from an idle timeout.

            1. max_processes
            2. number

            The number of processes associated with the current application pool. The default is 1.

            1. pinging_enabled
            2. boolean

            The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

            1. ping_interval
            2. number

            A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

            1. ping_response_time
            2. number

            A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

            1. shutdown_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

            1. startup_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

          1. identity
          2. object

          view child properties

            1. identity_type
            2. string

            The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

            1. username
            2. string

            The user name associated with the security identity under which the application pool runs.

            1. load_user_profile
            2. boolean

            true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

            1. password
            2. string

            A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

          1. recycling
          2. object

          view child properties

            1. disable_overlapped_recycle
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

            1. disable_recycle_on_config_change
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

            1. log_events
            2. object

            This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

            view child properties

              1. time
              2. boolean
              1. requeuessts
              2. boolean
              1. schedule
              2. boolean
              1. memory
              2. boolean
              1. isapi_unhealthy
              2. boolean
              1. on_demand
              2. boolean
              1. config_change
              2. boolean
              1. private_memory
              2. boolean
            1. periodic_restart
            2. object

            An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

            view child properties

              1. time_interval
              2. number

              A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

              1. private_memory
              2. number

              The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. request_limit
              2. number

              The number of requests that a worker process should process before it is recycled.

              1. virtual_memory
              2. number

              The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. schedule
              2. array

              A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

          1. rapid_fail_protection
          2. object

          view child properties

            1. enabled
            2. boolean

            true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

            1. load_balancer_capabilities
            2. string

            This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

            1. interval
            2. number

            A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

            1. max_crashes
            2. number

            The maximum number of application pool failures allowed. The default is 5.

            1. auto_shutdown_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

            1. auto_shutdown_params
            2. string

            The command-line parameters for the executable specified by the auto_shutdown_exe property.

          1. process_orphaning
          2. object

          view child properties

            1. enabled
            2. boolean

            This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

            1. orphan_action_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

            1. orphan_action_params
            2. string

            Command-line parameters for the executable specified by the orphan_action_exe property.

          1. _links
          2. object
        1. _links
        2. object
      1. application_pool
      2. object

      The application pool that the application belongs to.

      ApplicationPool

      view child properties

        1. name
        2. string

        The name of the application pool.

        1. id
        2. string

        A unique identifier for the application pool.

        1. status
        2. string

        The run-time state of the current application pool.

        1. auto_start
        2. boolean

        A value indicating whether the current application pool starts automatically when created or when IIS starts.

        1. pipeline_mode
        2. string

        This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

        1. managed_runtime_version
        2. string

        The version of the .NET Framework that is used for managed applications in the current application pool.

        1. queue_length
        2. number

        The maximum number of requests to queue before rejecting additional requests.

        1. cpu
        2. object

        CPU usage parameters for the current application pool.

        view child properties

          1. limit
          2. number

          The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

          1. limit_interval
          2. number

          A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

          1. action
          2. string

          The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

          1. processor_affinity_enabled
          2. boolean

          This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

          1. processor_affinity_mask32
          2. string

          A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

          1. processor_affinity_mask64
          2. string

          A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

        1. process_model
        2. object

        view child properties

          1. idle_timeout
          2. number

          The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

          1. idle_timeout_action
          2. string

          The action to perform if a worker process is shut down from an idle timeout.

          1. max_processes
          2. number

          The number of processes associated with the current application pool. The default is 1.

          1. pinging_enabled
          2. boolean

          The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

          1. ping_interval
          2. number

          A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

          1. ping_response_time
          2. number

          A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

          1. shutdown_time_limit
          2. number

          A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

          1. startup_time_limit
          2. number

          A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

        1. identity
        2. object

        view child properties

          1. identity_type
          2. string

          The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

          1. username
          2. string

          The user name associated with the security identity under which the application pool runs.

          1. load_user_profile
          2. boolean

          true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

          1. password
          2. string

          A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

        1. recycling
        2. object

        view child properties

          1. disable_overlapped_recycle
          2. boolean

          This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

          1. disable_recycle_on_config_change
          2. boolean

          This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

          1. log_events
          2. object

          This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

          view child properties

            1. time
            2. boolean
            1. requeuessts
            2. boolean
            1. schedule
            2. boolean
            1. memory
            2. boolean
            1. isapi_unhealthy
            2. boolean
            1. on_demand
            2. boolean
            1. config_change
            2. boolean
            1. private_memory
            2. boolean
          1. periodic_restart
          2. object

          An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

          view child properties

            1. time_interval
            2. number

            A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

            1. private_memory
            2. number

            The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

            1. request_limit
            2. number

            The number of requests that a worker process should process before it is recycled.

            1. virtual_memory
            2. number

            The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

            1. schedule
            2. array

            A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

        1. rapid_fail_protection
        2. object

        view child properties

          1. enabled
          2. boolean

          true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

          1. load_balancer_capabilities
          2. string

          This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

          1. interval
          2. number

          A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

          1. max_crashes
          2. number

          The maximum number of application pool failures allowed. The default is 5.

          1. auto_shutdown_exe
          2. string

          This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

          1. auto_shutdown_params
          2. string

          The command-line parameters for the executable specified by the auto_shutdown_exe property.

        1. process_orphaning
        2. object

        view child properties

          1. enabled
          2. boolean

          This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

          1. orphan_action_exe
          2. string

          This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

          1. orphan_action_params
          2. string

          Command-line parameters for the executable specified by the orphan_action_exe property.

        1. _links
        2. object

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

View the settings for a specific application.

Request

GET /api/webserver/webapps/{id}

Properties

    1. id (required)
    2. string

    The id of the application

Returns

HTTP RESPONSE CODES
    1. 200

    The application with the specified id.

    1. 404

    Cannot find the resource.

    1. default

    Error.

Update the application with the specified id.

Request

PATCH /api/webserver/webapps/{id}

Properties

    1. id (required)
    2. string

    The id for the application

    1. webapp (required)

    Application

    view child properties

      1. location
      2. string

      The full path of the application beginning with the web site name.

      1. id
      2. string

      A unique identifier for the application.

      1. path
      2. string

      The path of the application. This path is used to resolve the application in the URL relative to the root of the web site.

      1. physical_path
      2. string

      The location of the application's root directory in the file system

      1. enabled_protocols
      2. string

      Communication protocols that are enabled for the application.

      1. website
      2. object

      The web site that the application belongs to.

      WebSite

      view child properties

        1. id
        2. string

        A unique identifier for the web site.

        1. name
        2. string

        The name of the web site.

        1. physical_path
        2. string

        The location of the web site's root directory in the file system

        1. key
        2. number

        The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

        1. server_auto_start
        2. boolean

        A value indicating whether the web site should automatically start.

        1. enabled_protocols
        2. string

        Communication protocols that are enabled for the web site.

        1. limits
        2. object

        view child properties

          1. connection_timeout
          2. integer

          The period of time IIS waits before it considers a connection inactive.

          1. max_bandwidth
          2. integer

          Maximum network bandwidth in bytes per second.

          1. max_connections
          2. integer

          Maximum number of simultaneous connections allowed for a web site.

          1. max_url_segments
          2. integer

          Maximum number of URL segments allowed in any given request to the web site.

        1. bindings
        2. array

        WebSiteBinding

        view child properties

          1. protocol
          2. string

          The protocol the binding will listen for.

          1. binding_information
          2. string

          A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

          1. ip_address
          2. string

          The IP address the binding will listen for.

          1. port
          2. number

          The port the binding will listen on.

          1. hostname
          2. string

          The hostname that will resolve to the binding.

          1. certificate
          2. object

          Certificate

          view child properties

            1. alias
            2. string
            1. id
            2. string
            1. issued_by
            2. string
            1. subject
            2. string
            1. thumbprint
            2. string
            1. signature_algorithm
            2. string
            1. valid_from
            2. string
            1. valid_to
            2. string
            1. version
            2. number
            1. intended_purposes
            2. array
            1. private_key
            2. object

            view child properties

              1. exportable
              2. boolean
            1. subject_alternative_names
            2. array
            1. store
            2. object

            CertificateStore

            view child properties

              1. name
              2. string
              1. id
              2. string
              1. claims
              2. array
              1. _links
              2. object
            1. _links
            2. object
          1. require_sni
          2. boolean

          Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

        1. status
        2. string

        Status indicating whether or not the site is capable of handling requests.

        1. application_pool
        2. object

        ApplicationPool

        view child properties

          1. name
          2. string

          The name of the application pool.

          1. id
          2. string

          A unique identifier for the application pool.

          1. status
          2. string

          The run-time state of the current application pool.

          1. auto_start
          2. boolean

          A value indicating whether the current application pool starts automatically when created or when IIS starts.

          1. pipeline_mode
          2. string

          This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

          1. managed_runtime_version
          2. string

          The version of the .NET Framework that is used for managed applications in the current application pool.

          1. queue_length
          2. number

          The maximum number of requests to queue before rejecting additional requests.

          1. cpu
          2. object

          CPU usage parameters for the current application pool.

          view child properties

            1. limit
            2. number

            The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

            1. limit_interval
            2. number

            A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

            1. action
            2. string

            The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

            1. processor_affinity_enabled
            2. boolean

            This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

            1. processor_affinity_mask32
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. processor_affinity_mask64
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

          1. process_model
          2. object

          view child properties

            1. idle_timeout
            2. number

            The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

            1. idle_timeout_action
            2. string

            The action to perform if a worker process is shut down from an idle timeout.

            1. max_processes
            2. number

            The number of processes associated with the current application pool. The default is 1.

            1. pinging_enabled
            2. boolean

            The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

            1. ping_interval
            2. number

            A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

            1. ping_response_time
            2. number

            A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

            1. shutdown_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

            1. startup_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

          1. identity
          2. object

          view child properties

            1. identity_type
            2. string

            The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

            1. username
            2. string

            The user name associated with the security identity under which the application pool runs.

            1. load_user_profile
            2. boolean

            true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

            1. password
            2. string

            A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

          1. recycling
          2. object

          view child properties

            1. disable_overlapped_recycle
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

            1. disable_recycle_on_config_change
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

            1. log_events
            2. object

            This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

            view child properties

              1. time
              2. boolean
              1. requeuessts
              2. boolean
              1. schedule
              2. boolean
              1. memory
              2. boolean
              1. isapi_unhealthy
              2. boolean
              1. on_demand
              2. boolean
              1. config_change
              2. boolean
              1. private_memory
              2. boolean
            1. periodic_restart
            2. object

            An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

            view child properties

              1. time_interval
              2. number

              A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

              1. private_memory
              2. number

              The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. request_limit
              2. number

              The number of requests that a worker process should process before it is recycled.

              1. virtual_memory
              2. number

              The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. schedule
              2. array

              A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

          1. rapid_fail_protection
          2. object

          view child properties

            1. enabled
            2. boolean

            true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

            1. load_balancer_capabilities
            2. string

            This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

            1. interval
            2. number

            A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

            1. max_crashes
            2. number

            The maximum number of application pool failures allowed. The default is 5.

            1. auto_shutdown_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

            1. auto_shutdown_params
            2. string

            The command-line parameters for the executable specified by the auto_shutdown_exe property.

          1. process_orphaning
          2. object

          view child properties

            1. enabled
            2. boolean

            This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

            1. orphan_action_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

            1. orphan_action_params
            2. string

            Command-line parameters for the executable specified by the orphan_action_exe property.

          1. _links
          2. object
        1. _links
        2. object
      1. application_pool
      2. object

      The application pool that the application belongs to.

      ApplicationPool

      view child properties

        1. name
        2. string

        The name of the application pool.

        1. id
        2. string

        A unique identifier for the application pool.

        1. status
        2. string

        The run-time state of the current application pool.

        1. auto_start
        2. boolean

        A value indicating whether the current application pool starts automatically when created or when IIS starts.

        1. pipeline_mode
        2. string

        This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

        1. managed_runtime_version
        2. string

        The version of the .NET Framework that is used for managed applications in the current application pool.

        1. queue_length
        2. number

        The maximum number of requests to queue before rejecting additional requests.

        1. cpu
        2. object

        CPU usage parameters for the current application pool.

        view child properties

          1. limit
          2. number

          The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

          1. limit_interval
          2. number

          A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

          1. action
          2. string

          The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

          1. processor_affinity_enabled
          2. boolean

          This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

          1. processor_affinity_mask32
          2. string

          A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

          1. processor_affinity_mask64
          2. string

          A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

        1. process_model
        2. object

        view child properties

          1. idle_timeout
          2. number

          The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

          1. idle_timeout_action
          2. string

          The action to perform if a worker process is shut down from an idle timeout.

          1. max_processes
          2. number

          The number of processes associated with the current application pool. The default is 1.

          1. pinging_enabled
          2. boolean

          The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

          1. ping_interval
          2. number

          A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

          1. ping_response_time
          2. number

          A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

          1. shutdown_time_limit
          2. number

          A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

          1. startup_time_limit
          2. number

          A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

        1. identity
        2. object

        view child properties

          1. identity_type
          2. string

          The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

          1. username
          2. string

          The user name associated with the security identity under which the application pool runs.

          1. load_user_profile
          2. boolean

          true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

          1. password
          2. string

          A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

        1. recycling
        2. object

        view child properties

          1. disable_overlapped_recycle
          2. boolean

          This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

          1. disable_recycle_on_config_change
          2. boolean

          This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

          1. log_events
          2. object

          This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

          view child properties

            1. time
            2. boolean
            1. requeuessts
            2. boolean
            1. schedule
            2. boolean
            1. memory
            2. boolean
            1. isapi_unhealthy
            2. boolean
            1. on_demand
            2. boolean
            1. config_change
            2. boolean
            1. private_memory
            2. boolean
          1. periodic_restart
          2. object

          An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

          view child properties

            1. time_interval
            2. number

            A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

            1. private_memory
            2. number

            The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

            1. request_limit
            2. number

            The number of requests that a worker process should process before it is recycled.

            1. virtual_memory
            2. number

            The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

            1. schedule
            2. array

            A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

        1. rapid_fail_protection
        2. object

        view child properties

          1. enabled
          2. boolean

          true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

          1. load_balancer_capabilities
          2. string

          This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

          1. interval
          2. number

          A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

          1. max_crashes
          2. number

          The maximum number of application pool failures allowed. The default is 5.

          1. auto_shutdown_exe
          2. string

          This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

          1. auto_shutdown_params
          2. string

          The command-line parameters for the executable specified by the auto_shutdown_exe property.

        1. process_orphaning
        2. object

        view child properties

          1. enabled
          2. boolean

          This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

          1. orphan_action_exe
          2. string

          This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

          1. orphan_action_params
          2. string

          Command-line parameters for the executable specified by the orphan_action_exe property.

        1. _links
        2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 400

    Argument error.

    1. 404

    Cannot find the resource.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

CustomTagSets

Update the custom tag set for the Url Rewrite feature at a given scope in the configuration feature

Request

PATCH /api/webserver/url-rewrite/outbound/custom_tags/{id}

Properties

    1. id (required)
    2. string
    1. custom tag set (required)

    CustomTagSet

    view child properties

      1. name
      2. string
      1. id
      2. string
      1. tags
      2. object

      view child properties

        1. name
        2. string
        1. attribute
        2. string
      1. url_rewrite
      2. object

      UrlRewrite

      view child properties

        1. id
        2. string

        Unique identifier for the Url Rewrite feature.

        1. scope
        2. string

        The location in the configuration system that this resource reflects.

        1. website
        2. object

        WebSite

        view child properties

          1. id
          2. string

          A unique identifier for the web site.

          1. name
          2. string

          The name of the web site.

          1. physical_path
          2. string

          The location of the web site's root directory in the file system

          1. key
          2. number

          The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

          1. server_auto_start
          2. boolean

          A value indicating whether the web site should automatically start.

          1. enabled_protocols
          2. string

          Communication protocols that are enabled for the web site.

          1. limits
          2. object

          view child properties

            1. connection_timeout
            2. integer

            The period of time IIS waits before it considers a connection inactive.

            1. max_bandwidth
            2. integer

            Maximum network bandwidth in bytes per second.

            1. max_connections
            2. integer

            Maximum number of simultaneous connections allowed for a web site.

            1. max_url_segments
            2. integer

            Maximum number of URL segments allowed in any given request to the web site.

          1. bindings
          2. array

          WebSiteBinding

          view child properties

            1. protocol
            2. string

            The protocol the binding will listen for.

            1. binding_information
            2. string

            A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

            1. ip_address
            2. string

            The IP address the binding will listen for.

            1. port
            2. number

            The port the binding will listen on.

            1. hostname
            2. string

            The hostname that will resolve to the binding.

            1. certificate
            2. object

            Certificate

            view child properties

              1. alias
              2. string
              1. id
              2. string
              1. issued_by
              2. string
              1. subject
              2. string
              1. thumbprint
              2. string
              1. signature_algorithm
              2. string
              1. valid_from
              2. string
              1. valid_to
              2. string
              1. version
              2. number
              1. intended_purposes
              2. array
              1. private_key
              2. object

              view child properties

                1. exportable
                2. boolean
              1. subject_alternative_names
              2. array
              1. store
              2. object

              CertificateStore

              view child properties

                1. name
                2. string
                1. id
                2. string
                1. claims
                2. array
                1. _links
                2. object
              1. _links
              2. object
            1. require_sni
            2. boolean

            Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

          1. status
          2. string

          Status indicating whether or not the site is capable of handling requests.

          1. application_pool
          2. object

          ApplicationPool

          view child properties

            1. name
            2. string

            The name of the application pool.

            1. id
            2. string

            A unique identifier for the application pool.

            1. status
            2. string

            The run-time state of the current application pool.

            1. auto_start
            2. boolean

            A value indicating whether the current application pool starts automatically when created or when IIS starts.

            1. pipeline_mode
            2. string

            This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

            1. managed_runtime_version
            2. string

            The version of the .NET Framework that is used for managed applications in the current application pool.

            1. queue_length
            2. number

            The maximum number of requests to queue before rejecting additional requests.

            1. cpu
            2. object

            CPU usage parameters for the current application pool.

            view child properties

              1. limit
              2. number

              The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

              1. limit_interval
              2. number

              A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

              1. action
              2. string

              The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

              1. processor_affinity_enabled
              2. boolean

              This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

              1. processor_affinity_mask32
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

              1. processor_affinity_mask64
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. process_model
            2. object

            view child properties

              1. idle_timeout
              2. number

              The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

              1. idle_timeout_action
              2. string

              The action to perform if a worker process is shut down from an idle timeout.

              1. max_processes
              2. number

              The number of processes associated with the current application pool. The default is 1.

              1. pinging_enabled
              2. boolean

              The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

              1. ping_interval
              2. number

              A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

              1. ping_response_time
              2. number

              A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

              1. shutdown_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

              1. startup_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

            1. identity
            2. object

            view child properties

              1. identity_type
              2. string

              The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

              1. username
              2. string

              The user name associated with the security identity under which the application pool runs.

              1. load_user_profile
              2. boolean

              true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

              1. password
              2. string

              A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

            1. recycling
            2. object

            view child properties

              1. disable_overlapped_recycle
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

              1. disable_recycle_on_config_change
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

              1. log_events
              2. object

              This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

              view child properties

                1. time
                2. boolean
                1. requeuessts
                2. boolean
                1. schedule
                2. boolean
                1. memory
                2. boolean
                1. isapi_unhealthy
                2. boolean
                1. on_demand
                2. boolean
                1. config_change
                2. boolean
                1. private_memory
                2. boolean
              1. periodic_restart
              2. object

              An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

              view child properties

                1. time_interval
                2. number

                A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

                1. private_memory
                2. number

                The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. request_limit
                2. number

                The number of requests that a worker process should process before it is recycled.

                1. virtual_memory
                2. number

                The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. schedule
                2. array

                A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

            1. rapid_fail_protection
            2. object

            view child properties

              1. enabled
              2. boolean

              true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

              1. load_balancer_capabilities
              2. string

              This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

              1. interval
              2. number

              A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

              1. max_crashes
              2. number

              The maximum number of application pool failures allowed. The default is 5.

              1. auto_shutdown_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

              1. auto_shutdown_params
              2. string

              The command-line parameters for the executable specified by the auto_shutdown_exe property.

            1. process_orphaning
            2. object

            view child properties

              1. enabled
              2. boolean

              This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

              1. orphan_action_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

              1. orphan_action_params
              2. string

              Command-line parameters for the executable specified by the orphan_action_exe property.

            1. _links
            2. object
          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

DefaultDocument

Update the default document configuration feature for a certain level in the configuration

Request

PATCH /api/webserver/default-documents/{id}

Properties

    1. id (required)
    2. string

    The id for the default document feature

    1. feature (required)

    DefaultDocument

    view child properties

      1. enabled
      2. boolean

      This property specifies whether the default document feature is enabled at the specified scope.

      1. id
      2. string

      Unique identifier for the default document feature.

      1. scope
      2. string

      The location in the configuration system that this resource reflects.

      1. metadata
      2. object

      metadata

      view child properties

        1. is_local
        2. boolean
        1. is_locked
        2. boolean
        1. override_mode
        2. string
        1. override_mode_effective
        2. string
      1. website
      2. object

      WebSite

      view child properties

        1. id
        2. string

        A unique identifier for the web site.

        1. name
        2. string

        The name of the web site.

        1. physical_path
        2. string

        The location of the web site's root directory in the file system

        1. key
        2. number

        The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

        1. server_auto_start
        2. boolean

        A value indicating whether the web site should automatically start.

        1. enabled_protocols
        2. string

        Communication protocols that are enabled for the web site.

        1. limits
        2. object

        view child properties

          1. connection_timeout
          2. integer

          The period of time IIS waits before it considers a connection inactive.

          1. max_bandwidth
          2. integer

          Maximum network bandwidth in bytes per second.

          1. max_connections
          2. integer

          Maximum number of simultaneous connections allowed for a web site.

          1. max_url_segments
          2. integer

          Maximum number of URL segments allowed in any given request to the web site.

        1. bindings
        2. array

        WebSiteBinding

        view child properties

          1. protocol
          2. string

          The protocol the binding will listen for.

          1. binding_information
          2. string

          A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

          1. ip_address
          2. string

          The IP address the binding will listen for.

          1. port
          2. number

          The port the binding will listen on.

          1. hostname
          2. string

          The hostname that will resolve to the binding.

          1. certificate
          2. object

          Certificate

          view child properties

            1. alias
            2. string
            1. id
            2. string
            1. issued_by
            2. string
            1. subject
            2. string
            1. thumbprint
            2. string
            1. signature_algorithm
            2. string
            1. valid_from
            2. string
            1. valid_to
            2. string
            1. version
            2. number
            1. intended_purposes
            2. array
            1. private_key
            2. object

            view child properties

              1. exportable
              2. boolean
            1. subject_alternative_names
            2. array
            1. store
            2. object

            CertificateStore

            view child properties

              1. name
              2. string
              1. id
              2. string
              1. claims
              2. array
              1. _links
              2. object
            1. _links
            2. object
          1. require_sni
          2. boolean

          Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

        1. status
        2. string

        Status indicating whether or not the site is capable of handling requests.

        1. application_pool
        2. object

        ApplicationPool

        view child properties

          1. name
          2. string

          The name of the application pool.

          1. id
          2. string

          A unique identifier for the application pool.

          1. status
          2. string

          The run-time state of the current application pool.

          1. auto_start
          2. boolean

          A value indicating whether the current application pool starts automatically when created or when IIS starts.

          1. pipeline_mode
          2. string

          This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

          1. managed_runtime_version
          2. string

          The version of the .NET Framework that is used for managed applications in the current application pool.

          1. queue_length
          2. number

          The maximum number of requests to queue before rejecting additional requests.

          1. cpu
          2. object

          CPU usage parameters for the current application pool.

          view child properties

            1. limit
            2. number

            The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

            1. limit_interval
            2. number

            A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

            1. action
            2. string

            The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

            1. processor_affinity_enabled
            2. boolean

            This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

            1. processor_affinity_mask32
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. processor_affinity_mask64
            2. string

            A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

          1. process_model
          2. object

          view child properties

            1. idle_timeout
            2. number

            The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

            1. idle_timeout_action
            2. string

            The action to perform if a worker process is shut down from an idle timeout.

            1. max_processes
            2. number

            The number of processes associated with the current application pool. The default is 1.

            1. pinging_enabled
            2. boolean

            The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

            1. ping_interval
            2. number

            A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

            1. ping_response_time
            2. number

            A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

            1. shutdown_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

            1. startup_time_limit
            2. number

            A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

          1. identity
          2. object

          view child properties

            1. identity_type
            2. string

            The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

            1. username
            2. string

            The user name associated with the security identity under which the application pool runs.

            1. load_user_profile
            2. boolean

            true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

            1. password
            2. string

            A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

          1. recycling
          2. object

          view child properties

            1. disable_overlapped_recycle
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

            1. disable_recycle_on_config_change
            2. boolean

            This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

            1. log_events
            2. object

            This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

            view child properties

              1. time
              2. boolean
              1. requeuessts
              2. boolean
              1. schedule
              2. boolean
              1. memory
              2. boolean
              1. isapi_unhealthy
              2. boolean
              1. on_demand
              2. boolean
              1. config_change
              2. boolean
              1. private_memory
              2. boolean
            1. periodic_restart
            2. object

            An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

            view child properties

              1. time_interval
              2. number

              A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

              1. private_memory
              2. number

              The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. request_limit
              2. number

              The number of requests that a worker process should process before it is recycled.

              1. virtual_memory
              2. number

              The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

              1. schedule
              2. array

              A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

          1. rapid_fail_protection
          2. object

          view child properties

            1. enabled
            2. boolean

            true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

            1. load_balancer_capabilities
            2. string

            This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

            1. interval
            2. number

            A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

            1. max_crashes
            2. number

            The maximum number of application pool failures allowed. The default is 5.

            1. auto_shutdown_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

            1. auto_shutdown_params
            2. string

            The command-line parameters for the executable specified by the auto_shutdown_exe property.

          1. process_orphaning
          2. object

          view child properties

            1. enabled
            2. boolean

            This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

            1. orphan_action_exe
            2. string

            This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

            1. orphan_action_params
            2. string

            Command-line parameters for the executable specified by the orphan_action_exe property.

          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

Files

Returns a list of files and directories. Without specifying a folder via the 'parent.id' parameter, this endpoint will list the allowed root paths.

Request

GET /api/files[?fields&parent.id]

Properties

    1. fields
    2. string

    Select additional or specific fields for the files.

    1. parent.id
    2. string

    Populate the files list with children of the specified directory.

Returns

HTTP RESPONSE CODES
    1. 200

    An object containing the array of files.

    1. default

    Error.

Create a file

Request

POST /api/files

Properties

    1. file (required)

    File

    view child properties

      1. name
      2. string
      1. id
      2. string
      1. type
      2. string
      1. physical_path
      2. string
      1. exists
      2. boolean
      1. size
      2. integer
      1. created
      2. string
      1. last_modified
      2. string
      1. last_access
      2. string
      1. e_tag
      2. string
      1. total_files
      2. integer
      1. parent
      1. claims
      2. array
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

View the properties of a file.

Request

GET /api/files/{id}

Properties

    1. id (required)
    2. string

    The id of the file

Returns

HTTP RESPONSE CODES
    1. 200

    The file with the given id

    1. 404

    Cannot find the resource.

    1. default

    Error.

Update the file with the specified id.

Request

PATCH /api/files/{id}

Properties

    1. id (required)
    2. string

    The id for the file

    1. file (required)

    File

    view child properties

      1. name
      2. string
      1. id
      2. string
      1. type
      2. string
      1. physical_path
      2. string
      1. exists
      2. boolean
      1. size
      2. integer
      1. created
      2. string
      1. last_modified
      2. string
      1. last_access
      2. string
      1. e_tag
      2. string
      1. total_files
      2. integer
      1. parent
      1. claims
      2. array
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 400

    Argument error.

    1. 404

    Cannot find the resource.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

Delete the file with the specified id.

Request

DELETE /api/files/{id}

Properties

    1. id (required)
    2. string

    The id for the file

Returns

HTTP RESPONSE CODES
    1. 204

    success

    1. default

    Error.

Retrieves the headers for a file content request. Performing a head operation before a get allows a client to see how long the file is and then request the file in multiple sections.

Request

HEAD /api/files/content/{id}

Properties

    1. id (required)
    2. string

    The id of the file

Returns

HTTP RESPONSE CODES
    1. 200

    Headers for the content response

Retrieves the content of a file. This endpoint supports range requests to select sections of the files content.

Request

GET /api/files/content/{id}

Properties

    1. id (required)
    2. string

    The id of the file

Returns

HTTP RESPONSE CODES
    1. 200

    The content of the file with the given id

    1. 404

    Cannot find the resource.

    1. default

    Error.

Sets the content of a file. This endpoint supports range requests to update the file in parts.

Request

PUT /api/files/content/{id}

Properties

    1. id (required)
    2. string

    The id of the file

    1. content (required)

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 400

    Argument error.

    1. 404

    Cannot find the resource.

    1. default

    Error.

Creates a download link for the file specified in the body. The download link is returned in the location header.

Request

POST /api/files/downloads

Properties

    1. download (required)

    Download

    view child properties

      1. file
      2. object

      File

      view child properties

        1. name
        2. string
        1. id
        2. string
        1. type
        2. string
        1. physical_path
        2. string
        1. exists
        2. boolean
        1. size
        2. integer
        1. created
        2. string
        1. last_modified
        2. string
        1. last_access
        2. string
        1. e_tag
        2. string
        1. total_files
        2. integer
        1. parent
        1. claims
        2. array
        1. _links
        2. object
      1. ttl
      2. integer

      The total number of milliseconds the download will be available.

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

Copy a file or folder into a new directory. A folder cannot be copied into itself.

Request

POST /api/files/copy

Properties

    1. copyArgument (required)

    CopyArgument

    view child properties

      1. file
      2. object

      The file to copy.

      File

      view child properties

        1. name
        2. string
        1. id
        2. string
        1. type
        2. string
        1. physical_path
        2. string
        1. exists
        2. boolean
        1. size
        2. integer
        1. created
        2. string
        1. last_modified
        2. string
        1. last_access
        2. string
        1. e_tag
        2. string
        1. total_files
        2. integer
        1. parent
        1. claims
        2. array
        1. _links
        2. object
      1. parent
      2. object

      The folder to copy the file to.

      File

      view child properties

        1. name
        2. string
        1. id
        2. string
        1. type
        2. string
        1. physical_path
        2. string
        1. exists
        2. boolean
        1. size
        2. integer
        1. created
        2. string
        1. last_modified
        2. string
        1. last_access
        2. string
        1. e_tag
        2. string
        1. total_files
        2. integer
        1. parent
        1. claims
        2. array
        1. _links
        2. object
      1. name
      2. string

      The new name of the copy.

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

Retrieves resource indicating the progress of the copy operation.

Request

GET /api/files/copy/{id}

Properties

    1. id (required)
    2. string

    The id of the file

Returns

HTTP RESPONSE CODES
    1. 200

    A resource indicating the progress of the copy operation.

    1. 404

    Cannot find the resource.

    1. default

    Error.

Move a file or folder to a new directory. A folder cannot be moved into itself.

Request

POST /api/files/move

Properties

    1. moveArgument (required)

    MoveArgument

    view child properties

      1. file
      2. object

      The file to move.

      File

      view child properties

        1. name
        2. string
        1. id
        2. string
        1. type
        2. string
        1. physical_path
        2. string
        1. exists
        2. boolean
        1. size
        2. integer
        1. created
        2. string
        1. last_modified
        2. string
        1. last_access
        2. string
        1. e_tag
        2. string
        1. total_files
        2. integer
        1. parent
        1. claims
        2. array
        1. _links
        2. object
      1. parent
      2. object

      The folder to move the file to.

      File

      view child properties

        1. name
        2. string
        1. id
        2. string
        1. type
        2. string
        1. physical_path
        2. string
        1. exists
        2. boolean
        1. size
        2. integer
        1. created
        2. string
        1. last_modified
        2. string
        1. last_access
        2. string
        1. e_tag
        2. string
        1. total_files
        2. integer
        1. parent
        1. claims
        2. array
        1. _links
        2. object
      1. name
      2. string

      The new name of the file.

Returns

HTTP RESPONSE CODES
    1. 201

    Success.

    1. 400

    Argument error.

    1. 415

    Invalid JSON request object.

    1. default

    Error.

Retrieves resource indicating the progress of the move operation.

Request

GET /api/files/move/{id}

Properties

    1. id (required)
    2. string

    The id of the file

Returns

HTTP RESPONSE CODES
    1. 200

    A resource indicating the progress of the move operation.

    1. 404

    Cannot find the resource.

    1. default

    Error.

GlobalRules

Updates the global rules settings.

Request

PATCH /api/webserver/url-rewrite/global/{id}

Properties

    1. id (required)
    2. string

    The id for the global rules section

    1. feature (required)

    GlobalRulesSection

    view child properties

      1. id
      2. string
      1. scope
      2. string
      1. use_original_url_encoding
      2. boolean
      1. metadata
      2. object

      metadata

      view child properties

        1. is_local
        2. boolean
        1. is_locked
        2. boolean
        1. override_mode
        2. string
        1. override_mode_effective
        2. string
      1. url_rewrite
      2. object

      UrlRewrite

      view child properties

        1. id
        2. string

        Unique identifier for the Url Rewrite feature.

        1. scope
        2. string

        The location in the configuration system that this resource reflects.

        1. website
        2. object

        WebSite

        view child properties

          1. id
          2. string

          A unique identifier for the web site.

          1. name
          2. string

          The name of the web site.

          1. physical_path
          2. string

          The location of the web site's root directory in the file system

          1. key
          2. number

          The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

          1. server_auto_start
          2. boolean

          A value indicating whether the web site should automatically start.

          1. enabled_protocols
          2. string

          Communication protocols that are enabled for the web site.

          1. limits
          2. object

          view child properties

            1. connection_timeout
            2. integer

            The period of time IIS waits before it considers a connection inactive.

            1. max_bandwidth
            2. integer

            Maximum network bandwidth in bytes per second.

            1. max_connections
            2. integer

            Maximum number of simultaneous connections allowed for a web site.

            1. max_url_segments
            2. integer

            Maximum number of URL segments allowed in any given request to the web site.

          1. bindings
          2. array

          WebSiteBinding

          view child properties

            1. protocol
            2. string

            The protocol the binding will listen for.

            1. binding_information
            2. string

            A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

            1. ip_address
            2. string

            The IP address the binding will listen for.

            1. port
            2. number

            The port the binding will listen on.

            1. hostname
            2. string

            The hostname that will resolve to the binding.

            1. certificate
            2. object

            Certificate

            view child properties

              1. alias
              2. string
              1. id
              2. string
              1. issued_by
              2. string
              1. subject
              2. string
              1. thumbprint
              2. string
              1. signature_algorithm
              2. string
              1. valid_from
              2. string
              1. valid_to
              2. string
              1. version
              2. number
              1. intended_purposes
              2. array
              1. private_key
              2. object

              view child properties

                1. exportable
                2. boolean
              1. subject_alternative_names
              2. array
              1. store
              2. object

              CertificateStore

              view child properties

                1. name
                2. string
                1. id
                2. string
                1. claims
                2. array
                1. _links
                2. object
              1. _links
              2. object
            1. require_sni
            2. boolean

            Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

          1. status
          2. string

          Status indicating whether or not the site is capable of handling requests.

          1. application_pool
          2. object

          ApplicationPool

          view child properties

            1. name
            2. string

            The name of the application pool.

            1. id
            2. string

            A unique identifier for the application pool.

            1. status
            2. string

            The run-time state of the current application pool.

            1. auto_start
            2. boolean

            A value indicating whether the current application pool starts automatically when created or when IIS starts.

            1. pipeline_mode
            2. string

            This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

            1. managed_runtime_version
            2. string

            The version of the .NET Framework that is used for managed applications in the current application pool.

            1. queue_length
            2. number

            The maximum number of requests to queue before rejecting additional requests.

            1. cpu
            2. object

            CPU usage parameters for the current application pool.

            view child properties

              1. limit
              2. number

              The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

              1. limit_interval
              2. number

              A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

              1. action
              2. string

              The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

              1. processor_affinity_enabled
              2. boolean

              This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

              1. processor_affinity_mask32
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

              1. processor_affinity_mask64
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. process_model
            2. object

            view child properties

              1. idle_timeout
              2. number

              The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

              1. idle_timeout_action
              2. string

              The action to perform if a worker process is shut down from an idle timeout.

              1. max_processes
              2. number

              The number of processes associated with the current application pool. The default is 1.

              1. pinging_enabled
              2. boolean

              The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

              1. ping_interval
              2. number

              A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

              1. ping_response_time
              2. number

              A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

              1. shutdown_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

              1. startup_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

            1. identity
            2. object

            view child properties

              1. identity_type
              2. string

              The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

              1. username
              2. string

              The user name associated with the security identity under which the application pool runs.

              1. load_user_profile
              2. boolean

              true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

              1. password
              2. string

              A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

            1. recycling
            2. object

            view child properties

              1. disable_overlapped_recycle
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

              1. disable_recycle_on_config_change
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

              1. log_events
              2. object

              This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

              view child properties

                1. time
                2. boolean
                1. requeuessts
                2. boolean
                1. schedule
                2. boolean
                1. memory
                2. boolean
                1. isapi_unhealthy
                2. boolean
                1. on_demand
                2. boolean
                1. config_change
                2. boolean
                1. private_memory
                2. boolean
              1. periodic_restart
              2. object

              An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

              view child properties

                1. time_interval
                2. number

                A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

                1. private_memory
                2. number

                The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. request_limit
                2. number

                The number of requests that a worker process should process before it is recycled.

                1. virtual_memory
                2. number

                The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. schedule
                2. array

                A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

            1. rapid_fail_protection
            2. object

            view child properties

              1. enabled
              2. boolean

              true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

              1. load_balancer_capabilities
              2. string

              This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

              1. interval
              2. number

              A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

              1. max_crashes
              2. number

              The maximum number of application pool failures allowed. The default is 5.

              1. auto_shutdown_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

              1. auto_shutdown_params
              2. string

              The command-line parameters for the executable specified by the auto_shutdown_exe property.

            1. process_orphaning
            2. object

            view child properties

              1. enabled
              2. boolean

              This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

              1. orphan_action_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

              1. orphan_action_params
              2. string

              Command-line parameters for the executable specified by the orphan_action_exe property.

            1. _links
            2. object
          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

Update the global rule for the Url Rewrite feature at a given scope in the configuration feature

Request

PATCH /api/webserver/url-rewrite/global/rules/{id}

Properties

    1. id (required)
    2. string
    1. rule (required)

    GlobalRule

    view child properties

      1. name
      2. string
      1. id
      2. string
      1. priority
      2. integer
      1. pattern
      2. string
      1. pattern_syntax
      2. string
      1. ignore_case
      2. boolean
      1. negate
      2. boolean
      1. stop_processing
      2. boolean
      1. response_cache_directive
      2. string
      1. condition_match_constraints
      2. string
      1. track_all_captures
      2. boolean
      1. action
      2. object

      GlobalRuleAction

      view child properties

        1. type
        2. string
        1. url
        2. string
        1. append_query_string
        2. boolean
        1. log_rewritten_url
        2. boolean
      1. server_variables
      2. array

      view child properties

        1. name
        2. string
        1. value
        2. string
        1. replace
        2. boolean
      1. conditions
      2. array

      GlobalRuleCondition

      view child properties

        1. input
        2. string
        1. pattern
        2. string
        1. negate
        2. boolean
        1. ignore_case
        2. boolean
        1. match_type
        2. string
      1. url_rewrite
      2. object

      UrlRewrite

      view child properties

        1. id
        2. string

        Unique identifier for the Url Rewrite feature.

        1. scope
        2. string

        The location in the configuration system that this resource reflects.

        1. website
        2. object

        WebSite

        view child properties

          1. id
          2. string

          A unique identifier for the web site.

          1. name
          2. string

          The name of the web site.

          1. physical_path
          2. string

          The location of the web site's root directory in the file system

          1. key
          2. number

          The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

          1. server_auto_start
          2. boolean

          A value indicating whether the web site should automatically start.

          1. enabled_protocols
          2. string

          Communication protocols that are enabled for the web site.

          1. limits
          2. object

          view child properties

            1. connection_timeout
            2. integer

            The period of time IIS waits before it considers a connection inactive.

            1. max_bandwidth
            2. integer

            Maximum network bandwidth in bytes per second.

            1. max_connections
            2. integer

            Maximum number of simultaneous connections allowed for a web site.

            1. max_url_segments
            2. integer

            Maximum number of URL segments allowed in any given request to the web site.

          1. bindings
          2. array

          WebSiteBinding

          view child properties

            1. protocol
            2. string

            The protocol the binding will listen for.

            1. binding_information
            2. string

            A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

            1. ip_address
            2. string

            The IP address the binding will listen for.

            1. port
            2. number

            The port the binding will listen on.

            1. hostname
            2. string

            The hostname that will resolve to the binding.

            1. certificate
            2. object

            Certificate

            view child properties

              1. alias
              2. string
              1. id
              2. string
              1. issued_by
              2. string
              1. subject
              2. string
              1. thumbprint
              2. string
              1. signature_algorithm
              2. string
              1. valid_from
              2. string
              1. valid_to
              2. string
              1. version
              2. number
              1. intended_purposes
              2. array
              1. private_key
              2. object

              view child properties

                1. exportable
                2. boolean
              1. subject_alternative_names
              2. array
              1. store
              2. object

              CertificateStore

              view child properties

                1. name
                2. string
                1. id
                2. string
                1. claims
                2. array
                1. _links
                2. object
              1. _links
              2. object
            1. require_sni
            2. boolean

            Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

          1. status
          2. string

          Status indicating whether or not the site is capable of handling requests.

          1. application_pool
          2. object

          ApplicationPool

          view child properties

            1. name
            2. string

            The name of the application pool.

            1. id
            2. string

            A unique identifier for the application pool.

            1. status
            2. string

            The run-time state of the current application pool.

            1. auto_start
            2. boolean

            A value indicating whether the current application pool starts automatically when created or when IIS starts.

            1. pipeline_mode
            2. string

            This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

            1. managed_runtime_version
            2. string

            The version of the .NET Framework that is used for managed applications in the current application pool.

            1. queue_length
            2. number

            The maximum number of requests to queue before rejecting additional requests.

            1. cpu
            2. object

            CPU usage parameters for the current application pool.

            view child properties

              1. limit
              2. number

              The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

              1. limit_interval
              2. number

              A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

              1. action
              2. string

              The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

              1. processor_affinity_enabled
              2. boolean

              This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

              1. processor_affinity_mask32
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

              1. processor_affinity_mask64
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. process_model
            2. object

            view child properties

              1. idle_timeout
              2. number

              The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

              1. idle_timeout_action
              2. string

              The action to perform if a worker process is shut down from an idle timeout.

              1. max_processes
              2. number

              The number of processes associated with the current application pool. The default is 1.

              1. pinging_enabled
              2. boolean

              The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

              1. ping_interval
              2. number

              A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

              1. ping_response_time
              2. number

              A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

              1. shutdown_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

              1. startup_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

            1. identity
            2. object

            view child properties

              1. identity_type
              2. string

              The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

              1. username
              2. string

              The user name associated with the security identity under which the application pool runs.

              1. load_user_profile
              2. boolean

              true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

              1. password
              2. string

              A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

            1. recycling
            2. object

            view child properties

              1. disable_overlapped_recycle
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

              1. disable_recycle_on_config_change
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

              1. log_events
              2. object

              This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

              view child properties

                1. time
                2. boolean
                1. requeuessts
                2. boolean
                1. schedule
                2. boolean
                1. memory
                2. boolean
                1. isapi_unhealthy
                2. boolean
                1. on_demand
                2. boolean
                1. config_change
                2. boolean
                1. private_memory
                2. boolean
              1. periodic_restart
              2. object

              An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

              view child properties

                1. time_interval
                2. number

                A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

                1. private_memory
                2. number

                The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. request_limit
                2. number

                The number of requests that a worker process should process before it is recycled.

                1. virtual_memory
                2. number

                The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. schedule
                2. array

                A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

            1. rapid_fail_protection
            2. object

            view child properties

              1. enabled
              2. boolean

              true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

              1. load_balancer_capabilities
              2. string

              This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

              1. interval
              2. number

              A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

              1. max_crashes
              2. number

              The maximum number of application pool failures allowed. The default is 5.

              1. auto_shutdown_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

              1. auto_shutdown_params
              2. string

              The command-line parameters for the executable specified by the auto_shutdown_exe property.

            1. process_orphaning
            2. object

            view child properties

              1. enabled
              2. boolean

              This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

              1. orphan_action_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

              1. orphan_action_params
              2. string

              Command-line parameters for the executable specified by the orphan_action_exe property.

            1. _links
            2. object
          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

InboundRules

Updates the inbound rules settings.

Request

PATCH /api/webserver/url-rewrite/inbound/{id}

Properties

    1. id (required)
    2. string

    The id for the inbound rules section

    1. feature (required)

    InboundRulesSection

    view child properties

      1. id
      2. string
      1. scope
      2. string
      1. use_original_url_encoding
      2. boolean
      1. metadata
      2. object

      metadata

      view child properties

        1. is_local
        2. boolean
        1. is_locked
        2. boolean
        1. override_mode
        2. string
        1. override_mode_effective
        2. string
      1. url_rewrite
      2. object

      UrlRewrite

      view child properties

        1. id
        2. string

        Unique identifier for the Url Rewrite feature.

        1. scope
        2. string

        The location in the configuration system that this resource reflects.

        1. website
        2. object

        WebSite

        view child properties

          1. id
          2. string

          A unique identifier for the web site.

          1. name
          2. string

          The name of the web site.

          1. physical_path
          2. string

          The location of the web site's root directory in the file system

          1. key
          2. number

          The unique ID of the web site as seen in IIS's applicationHost.config file. This key can be used to correlate sites between different IIS management systems.

          1. server_auto_start
          2. boolean

          A value indicating whether the web site should automatically start.

          1. enabled_protocols
          2. string

          Communication protocols that are enabled for the web site.

          1. limits
          2. object

          view child properties

            1. connection_timeout
            2. integer

            The period of time IIS waits before it considers a connection inactive.

            1. max_bandwidth
            2. integer

            Maximum network bandwidth in bytes per second.

            1. max_connections
            2. integer

            Maximum number of simultaneous connections allowed for a web site.

            1. max_url_segments
            2. integer

            Maximum number of URL segments allowed in any given request to the web site.

          1. bindings
          2. array

          WebSiteBinding

          view child properties

            1. protocol
            2. string

            The protocol the binding will listen for.

            1. binding_information
            2. string

            A serialized string that describes the binding in the following format '{IP address}:{port}:{hostname}'.

            1. ip_address
            2. string

            The IP address the binding will listen for.

            1. port
            2. number

            The port the binding will listen on.

            1. hostname
            2. string

            The hostname that will resolve to the binding.

            1. certificate
            2. object

            Certificate

            view child properties

              1. alias
              2. string
              1. id
              2. string
              1. issued_by
              2. string
              1. subject
              2. string
              1. thumbprint
              2. string
              1. signature_algorithm
              2. string
              1. valid_from
              2. string
              1. valid_to
              2. string
              1. version
              2. number
              1. intended_purposes
              2. array
              1. private_key
              2. object

              view child properties

                1. exportable
                2. boolean
              1. subject_alternative_names
              2. array
              1. store
              2. object

              CertificateStore

              view child properties

                1. name
                2. string
                1. id
                2. string
                1. claims
                2. array
                1. _links
                2. object
              1. _links
              2. object
            1. require_sni
            2. boolean

            Indicated whether the binding should require Server Name Identification from clients in order to take the request. This property is only available on HTTPS bindings that have an SSL certificate.

          1. status
          2. string

          Status indicating whether or not the site is capable of handling requests.

          1. application_pool
          2. object

          ApplicationPool

          view child properties

            1. name
            2. string

            The name of the application pool.

            1. id
            2. string

            A unique identifier for the application pool.

            1. status
            2. string

            The run-time state of the current application pool.

            1. auto_start
            2. boolean

            A value indicating whether the current application pool starts automatically when created or when IIS starts.

            1. pipeline_mode
            2. string

            This property specifies whether the request-processing pipeline mode is Integrated or Classic. In Classic mode, managed application events are executed by using ISAPI. In Integrated mode, ASP.NET request processing integrates directly into the IIS request-processing pipeline. Integrated mode enables you to configure managed modules for Web sites that are developed with unmanaged code. For example, you can use managed Forms authentication for a Web site that is developed with ASP.

            1. managed_runtime_version
            2. string

            The version of the .NET Framework that is used for managed applications in the current application pool.

            1. queue_length
            2. number

            The maximum number of requests to queue before rejecting additional requests.

            1. cpu
            2. object

            CPU usage parameters for the current application pool.

            view child properties

              1. limit
              2. number

              The maximum percentage of CPU time, in hundredths of one percent, that the worker processes in an application pool are allowed to consume over a period of time. The default is 0, which disables CPU limiting.

              1. limit_interval
              2. number

              A time in minutes that specifies the reset period for CPU monitoring and throttling limits on an application pool. The default is 0, which disables CPU monitoring.

              1. action
              2. string

              The actions that IIS takes when an application pool exceeds the CPU limit specified by the Limit property.

              1. processor_affinity_enabled
              2. boolean

              This property specifies whether a particular worker process assigned to an application pool should also be assigned to a given CPU. This property is used in combination with the processor_affinity_mask property.

              1. processor_affinity_mask32
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

              1. processor_affinity_mask64
              2. string

              A value that indicates the CPU affinity for the application pool. The default is 0xFFFFFFFF.

            1. process_model
            2. object

            view child properties

              1. idle_timeout
              2. number

              The period of time in minutes that a worker process should run if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process will be shut down.

              1. idle_timeout_action
              2. string

              The action to perform if a worker process is shut down from an idle timeout.

              1. max_processes
              2. number

              The number of processes associated with the current application pool. The default is 1.

              1. pinging_enabled
              2. boolean

              The pinging behavior for the worker process health monitoring. true if the process model supports health-monitor pinging; otherwise, false. The default is true.

              1. ping_interval
              2. number

              A value in seconds that specifies the interval between health-monitoring pings that the WWW service sends to a worker process. The default is 30 seconds.

              1. ping_response_time
              2. number

              A value in seconds that specifies the period of time that a worker process is given to respond to a health-monitoring ping. The default is 90 seconds.

              1. shutdown_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for requests to finish running in a worker process before IIS terminates the worker process. The default is 90 seconds.

              1. startup_time_limit
              2. number

              A value in seconds that specifies the period of time that IIS waits for an application pool to start. The default is 90 seconds.

            1. identity
            2. object

            view child properties

              1. identity_type
              2. string

              The values of this enumeration enable you to configure your application pools to run under the security context of an existing security account or a custom account. If you configure the process model to use the SpecificUser value, you must also configure the username and password properties of the identity property.

              1. username
              2. string

              The user name associated with the security identity under which the application pool runs.

              1. load_user_profile
              2. boolean

              true if the user profile will be loaded when the application pool starts; otherwise, false. The default is false.

              1. password
              2. string

              A write-only property specifying the password to use with the given username if identity_type is set to SpecificUser.

            1. recycling
            2. object

            view child properties

              1. disable_overlapped_recycle
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should start another worker process to replace the existing worker process while it is shutting down. You should set the value of this property to true if the worker process loads application code that does not support multiple instances of worker processes. true if overlapping rotation is not allowed; otherwise, false. The default is false.

              1. disable_recycle_on_config_change
              2. boolean

              This property specifies whether the World Wide Web Publishing Service (WWW service) should rotate worker processes in an application pool when the configuration changes. true if config change recycling is not allowed; otherwise, false. The default is false.

              1. log_events
              2. object

              This property specifies that IIS should log an event when an application pool is recycled for one or more of the reasons defined.

              view child properties

                1. time
                2. boolean
                1. requeuessts
                2. boolean
                1. schedule
                2. boolean
                1. memory
                2. boolean
                1. isapi_unhealthy
                2. boolean
                1. on_demand
                2. boolean
                1. config_change
                2. boolean
                1. private_memory
                2. boolean
              1. periodic_restart
              2. object

              An object that can be used to conditionally restart application pools. Application pools can be conditionally restarted based on limits of virtual memory, private memory, the number of requests, or time periods. Application pools can also be periodically restarted at any number of scheduled times. The object returned by this property provides access to configure all conditional and periodic application pool restarts.

              view child properties

                1. time_interval
                2. number

                A value in minutes that specifies the period of time that should elapse before a worker process is recycled. The default is 1740.

                1. private_memory
                2. number

                The amount of private memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. request_limit
                2. number

                The number of requests that a worker process should process before it is recycled.

                1. virtual_memory
                2. number

                The amount of virtual memory, in kilobytes, that a worker process can use before the worker process is recycled. The default is 0.

                1. schedule
                2. array

                A list of specific times local times, in 24 hour format, when the application pool is recycled. e.g. 08:00, 15:00, 21:30.

            1. rapid_fail_protection
            2. object

            view child properties

              1. enabled
              2. boolean

              true indicates that the applications in an application pool are put out of service when the number of worker process crashes reaches the maximum specified by the max_crashes property within the time specified by the interval property. The default is true. When an application pool detects that too many of its worker processes have become unhealthy in a specified period of time, rapid-fail protection is initiated. The communication channel for IIS is dropped. IIS detects the loss of communication, sends an error or warning to the event log, and then restarts the worker process. The application pool is taken out of service, and the kernel-mode driver returns an out-of-service message (503 Service Unavailable) to requests to that application pool.

              1. load_balancer_capabilities
              2. string

              This property specifies behavior when a worker process cannot be started (for example, when the request queue is full or an application pool is in rapid-fail protection). A value of TcpLevel terminates the connection. The default value of HttpLevel sends error code 503 (Service Unavailable).

              1. interval
              2. number

              A value in minutes that indicates the interval of time before the failure count for a process is reset. The default is 5 minutes.

              1. max_crashes
              2. number

              The maximum number of application pool failures allowed. The default is 5.

              1. auto_shutdown_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. Use the auto_shutdown_params property to set parameters for the executable.

              1. auto_shutdown_params
              2. string

              The command-line parameters for the executable specified by the auto_shutdown_exe property.

            1. process_orphaning
            2. object

            view child properties

              1. enabled
              2. boolean

              This property specifies whether to assign a worker process to an orphan state instead of terminating it when an application pool fails.

              1. orphan_action_exe
              2. string

              This property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process.

              1. orphan_action_params
              2. string

              Command-line parameters for the executable specified by the orphan_action_exe property.

            1. _links
            2. object
          1. _links
          2. object
        1. _links
        2. object
      1. _links
      2. object

Returns

HTTP RESPONSE CODES
    1. 200

    Success

    1. 404

    Cannot find the resource.

Update the inbound rule for the Url Rewrite feature at a given scope in the configuration feature

Request

PATCH /api/webserver/url-rewrite/inbound/rules/{id}

Properties

    1. id (required)
    2. string
    1. rule (required)

    InboundRule

    view child properties

      1. name
      2. string
      1. id
      2. string
      1. priority
      2. integer
      1. pattern
      2. string
      1. pattern_syntax
      2. string
      1. ignore_case
      2. bo