Waiting for engine...
Skip to main content

Shared Server Information object

The Shared Server Information object provides information about the configuration of a Runtime’s shared web server.

Structure​

<SharedServerInformation sslCertificateId="" atomId="" checkForwardedHeaders="" maxThreads="" 
externalHttpsPort="" externalHttpPort="" externalHost="" internalHost="" minAuth="" auth="" 
httpsPort="" httpPort="" authToken="" overrideUrl="" url="" apiType=""/>
FieldTypeDescription
FilterFilterFilter
sslCertificateIdstringThe component ID for the SSL certificate used by the server, if applicable.
atomIdstringThe ID of the Runtime that is hosting the shared web server.
checkForwardedHeadersbooleanInformation regarding the external host, might be forwarded in headers. The embedded Java technology is capable of examining these headers and extracting external host information for response and callback purposes. Set this to true to enable the server to check for this information. The default is false.
maxThreadsintThe maximum number of handler threads that the listen process spawn. It queues other requests.
externalHttpsPortstringThe external HTTPS port routes to the shared web server listener.
externalHttpPortstringThe external HTTP port routes to the shared web server listener.
externalHoststringThe external host name or IP for the listener.
internalHoststringFor multi-homed boxes, the IP address you want to use for binding to a specific interface.
minAuthstringThe minimum authentication required by the web server. Options are none and basic. The are multi-tenant, so the default is set to basic. The default for local runtimes and runtime cloud clusters is none.
authstringThe authentication required by the web server. Options are none and basic. If minAuth is set to basic, you must also set auth to basic.
httpsPortstringThe SSL (HTTPS) port on which the web server listens, if applicable. The default port is 9093.
httpPortstringThe HTTP port on which the web server listens. The default port is 9090.
authTokenstringIf you configure BASIC authentication, this is an authentication token for connecting to the shared web server. You cannot update this with the UPDATE operation.
overrideUrlbooleanAllows manual overriding of the exposed URL used to connect to the shared web server. This value is for informational purposes for any tenant. By default, this is false, meaning the URL is constructed based on the host name or external host name and port or SSL port settings. Set this to true to specify a custom URL attribute value.
urlstringThe URL for connecting to the shared web server.
apiTypestringThe level of user management and API management functionality applicable to the shared web server.Options are basic, intermediate, and advanced. The default is intermediate.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Not supported Not supported SupportedNot supported  Not supported

Notes:

  • You can retrieve Shared Server Information records only by an ordinary GET operation specifying a single Runtime ID or a bulk GET operation with a maximum of 100 Runtime IDs. This option is because the object ID for the Shared Server Information is not available currently (except by requesting the information from services). Therefore, this operation does not return the Shared Server Information object auth field.

  • The UPDATE operation updates a Shared Server Information object based on the supplied Runtime ID. To clear a field, set the attribute corresponding to that field to an empty string.

    You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update shared server information.

    It is not possible to set authToken through this operation. This operation generates a token if it requires authentication, but a token does not currently exist. The new authToken appears in the response.

    If you specify sslCertificateId, the certificate must be accessible by the account making the request.

  • If you do not configure the Authentication Type and Ports, using the Shared Server Information object to update only the API Type of a Runtime fails. If you are the owner of a runtime, Runtime cluster, or Runtime cloud, you must update the API Type, Authentication Type, and HTTP Port or HTTPS Port through the Shared Server Information object for the API to succeed. Runtime cloud attachments cannot update the HTTP Port or HTTPS Port.

    If you configure the Authentication Type and Ports, you can use the Shared Server Information object to update only the API Type of a Runtime.

  • This API does not support the configuration of multiple authentication types on a Runtime.

SOAP implementation​

  • GET operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:get>
             <api:objectType>SharedServerInformation</api:objectType>
             <api:objectId>3456789a-bcde-f012-3456-789abcdef012</api:objectId>
          </api:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:SharedServerInformation" sslCertificateId="6789abcd-ef01-2345-6789-abcdef012345" 
             atomId="3456789a-bcde-f012-3456-789abcdef012" checkForwardedHeaders="false" maxThreads="250" 
             externalHttpsPort="0" externalHttpPort="0" externalHost="" internalHost="127.0.0.1" 
             minAuth="basic" httpsPort="9093" httpPort="9090"  
             authToken="bcdef012-3456-789a-bcde-f0123456789a" overrideUrl="false" 
             url="http://system.sub.domain.tld:9090" apiType="basic"/>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    Important

    If you do not configure the Authentication Type and Ports, using the Shared Server Information object to update only the API Type of a Runtime fails. If you are the owner of a runtime, Runtime cluster, or Runtime cloud, you must update the API Type, Authentication Type, and HTTP Port or HTTPS Port through the Shared Server Information object for the API to succeed. Runtime cloud attachments cannot update the HTTP Port or HTTPS Port. This data is the throughput size — the total volume, in bytes, of inbound and outbound documents — across all accounts in a particular account group on a specific date. QUERY operations retrieve this data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis.

    If you configured the Authentication Type and Ports, you can use the Shared Server Information object to update only the API Type of a Runtime.

    This example updates maxThreads, the maximum number of handler threads that the listen process spawns, up to 100.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:update>
              <object xsi:type="api:SharedServerInformation" atomId="3456789a-bcde-f012-3456-789abcdef012" 
                  maxThreads="100" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
              </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <result xsi:type="bns:SharedServerInformation" sslCertificateId="6789abcd-ef01-2345-6789-abcdef012345" 
                 atomId="f453d1ed-fd7e-4a61-8edf-d61f73a01adb" checkForwardedHeaders="false" maxThreads="100" 
                 externalHttpsPort="0" externalHttpPort="0" externalHost="" internalHost="127.0.0.1" 
                 minAuth="basic" auth="basic" httpsPort="9093" httpPort="9090"
                 authToken="bcdef012-3456-789a-bcde-f0123456789a" overrideUrl="false" 
                 url="http://system.sub.domain.tld:9090" apiType="basic"/>
          </bns:updateResponse>
       </S:Body>
    </S:Envelope>

On this Page