24 Webserver Connector

24.1 Get-anynodeWebserverConnectors

Returns the currently configured webserver connectors.

Required Permissions

  • API

  • Web server Read Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

Return Value Structure

The response body is strutured as an array. The array consists of WebserverConnector JSON objects. A description for its fields is at section 29.97.1. For the JSON schema refer to section 29.97.2.

24.2 Set-anynodeWebserverConnectors

Modifies the webserver connectors.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • WebserverConnectorTable

    Array of type section 29.97.1

Return Value Structure

The response body is strutured as an array. The array consists of WebserverConnector JSON objects. A description for its fields is at section 29.97.1. For the JSON schema refer to section 29.97.2.

24.3 Add-anynodeWebserverConnectors

Adds a new webserver connector.

Required Permissions

  • API

  • Web server Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • DisplayName

    A name for this connector to identify it.

    Type: String

  • HttpMode

    This option determines if HTTP or HTTPS is used to communicate with this connector.

    Type: HttpMode

    Possible values:

    • HTTP

    • HTTPS

  • HttpRedirectorPort

    An optional second port that can redirect HTTP requests to a HTTPS connector. Only works for "httpMode=HTTPS".

    Type: Integer

  • Id

    The identifier of the webserver connector. Will be auto-generated when a connector is added.

    Type: String

  • NetworkOptions

    Type: WebserverConnectorNetworkOptions section 29.59

  • OpenPortOnDemand

    If set to true the port will only be opened when necessary to fulfill the services.

    Type: Boolean

  • ConnectorPort

    The port that this connector will listen on.

    Type: Integer

  • RequestDomains

    The list of available services for this connector.

    Type: Array of WebserverConnectorRequestDomain

    Possible values:

    • ACME

    • GUI

    • REST_API

  • TlsOptions

    TLS specifc options. Only used for "httpMode=HTTPS"

    Type: WebserverConnectorTlsOptions section 29.60

Return Value Structure

The response body is strutured as an array. The array consists of WebserverConnector JSON objects. A description for its fields is at section 29.97.1. For the JSON schema refer to section 29.97.2.

24.4 Remove-anynodeWebserverConnectors

Removes a webserver connector.

Required Permissions

  • API

  • Web server Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Identifier

    The identifier of the connector, that should be removed.

Return Value Structure

The response body is strutured as an array. The array consists of WebserverConnector JSON objects. A description for its fields is at section 29.97.1. For the JSON schema refer to section 29.97.2.