Boomi Platform API Reference (1.0.0) - SharedServerInformation

Toggle Pane

• SharedServerInformation
  • getRetrieves an instance of a SharedServerInformation object
  • postModifies or updates a SharedServerInformation object
  • postRetrieves multiple SharedServerInformation objects by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

SharedServerInformation

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

Required Privileges

You need these privileges in the target environment:

Read and Write access

• API — Use the Boomi Platform API to access account data.
• ATOM_MANAGEMENT — Configure and administer integration runtimes.

Retrieves an instance of a SharedServerInformation object

Retrieve Shared Server Information records for a specific single Runtime ID.

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.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the Runtime that is hosting the shared web server.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

apiType	string Enum: "basic" "intermediate" "advanced" The level of user management and API management functionality applicable to the shared web server.Options are basic, intermediate, and advanced. The default is intermediate.
atomId	string The ID of the Runtime that is hosting the shared web server.
auth	string Enum: "none" "basic" The authentication required by the web server. Options are none and basic. If minAuth is set to basic, you must also set auth to basic.
authToken	string If you configure BASIC authentication, this is an authentication token for connecting to the shared web server. You cannot update this with the UPDATE operation.
checkForwardedHeaders	boolean Information 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.
externalHost	string The external host name or IP for the listener.
externalHttpPort	integer <int32> The external HTTP port routes to the shared web server listener.
externalHttpsPort	integer <int32> The external HTTPS port routes to the shared web server listener.
httpPort	integer <int32> The HTTP port on which the web server listens. The default port is 9090.
httpsPort	integer <int32> The SSL (HTTPS) port on which the web server listens, if applicable. The default port is 9093.
internalHost	string For multi-homed boxes, the IP address you want to use for binding to a specific interface.
maxThreads	integer <int32> The maximum number of handler threads that the listen process spawn. It queues other requests.
minAuth	string Enum: "none" "basic" The 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 clusters is none.
overrideUrl	boolean Allows 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.
sslCertificateId	string The component ID for the SSL certificate used by the server, if applicable.
url	string The URL for connecting to the shared web server.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/SharedServerInformation/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SharedServerInformation",
• "apiType": "basic",
• "url": "http://system.sub.domain.tld:9090",
• "overrideUrl": false,
• "authToken": "bcdef012-3456-789a-bcde-f0123456789a",
• "httpPort": 9090,
• "httpsPort": 9093,
• "minAuth": "basic",
• "internalHost": "127.0.0.1",
• "externalHost": "",
• "externalHttpPort": 0,
• "externalHttpsPort": 0,
• "maxThreads": 250,
• "checkForwardedHeaders": false,
• "atomId": "3456789a-bcde-f012-3456-789abcdef012",
• "sslCertificateId": "6789abcd-ef01-2345-6789-abcdef012345",
• "auth": "basic"

}

Modifies or updates a SharedServerInformation object

Updates a Shared Server Information object based on the supplied Runtime ID.

• 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.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the Runtime that is hosting the shared web server.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

apiType	string Enum: "basic" "intermediate" "advanced" The level of user management and API management functionality applicable to the shared web server.Options are basic, intermediate, and advanced. The default is intermediate.
atomId	string The ID of the Runtime that is hosting the shared web server.
auth	string Enum: "none" "basic" The authentication required by the web server. Options are none and basic. If minAuth is set to basic, you must also set auth to basic.
authToken	string If you configure BASIC authentication, this is an authentication token for connecting to the shared web server. You cannot update this with the UPDATE operation.
checkForwardedHeaders	boolean Information 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.
externalHost	string The external host name or IP for the listener.
externalHttpPort	integer <int32> The external HTTP port routes to the shared web server listener.
externalHttpsPort	integer <int32> The external HTTPS port routes to the shared web server listener.
httpPort	integer <int32> The HTTP port on which the web server listens. The default port is 9090.
httpsPort	integer <int32> The SSL (HTTPS) port on which the web server listens, if applicable. The default port is 9093.
internalHost	string For multi-homed boxes, the IP address you want to use for binding to a specific interface.
maxThreads	integer <int32> The maximum number of handler threads that the listen process spawn. It queues other requests.
minAuth	string Enum: "none" "basic" The 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 clusters is none.
overrideUrl	boolean Allows 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.
sslCertificateId	string The component ID for the SSL certificate used by the server, if applicable.
url	string The URL for connecting to the shared web server.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

apiType	string Enum: "basic" "intermediate" "advanced" The level of user management and API management functionality applicable to the shared web server.Options are basic, intermediate, and advanced. The default is intermediate.
atomId	string The ID of the Runtime that is hosting the shared web server.
auth	string Enum: "none" "basic" The authentication required by the web server. Options are none and basic. If minAuth is set to basic, you must also set auth to basic.
authToken	string If you configure BASIC authentication, this is an authentication token for connecting to the shared web server. You cannot update this with the UPDATE operation.
checkForwardedHeaders	boolean Information 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.
externalHost	string The external host name or IP for the listener.
externalHttpPort	integer <int32> The external HTTP port routes to the shared web server listener.
externalHttpsPort	integer <int32> The external HTTPS port routes to the shared web server listener.
httpPort	integer <int32> The HTTP port on which the web server listens. The default port is 9090.
httpsPort	integer <int32> The SSL (HTTPS) port on which the web server listens, if applicable. The default port is 9093.
internalHost	string For multi-homed boxes, the IP address you want to use for binding to a specific interface.
maxThreads	integer <int32> The maximum number of handler threads that the listen process spawn. It queues other requests.
minAuth	string Enum: "none" "basic" The 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 clusters is none.
overrideUrl	boolean Allows 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.
sslCertificateId	string The component ID for the SSL certificate used by the server, if applicable.
url	string The URL for connecting to the shared web server.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/SharedServerInformation/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "maxThreads": 100,
• "atomId": "3456789a-bcde-f012-3456-789abcdef012"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SharedServerInformation",
• "maxThreads": 250,
• "atomId": "3456789a-bcde-f012-3456-789abcdef012",
• "apiType": "basic",
• "url": "http://system.sub.domain.tld:9090",
• "overrideUrl": false,
• "authToken": "bcdef012-3456-789a-bcde-f0123456789a",
• "httpPort": 9090,
• "httpsPort": 9093,
• "minAuth": "basic",
• "internalHost": "127.0.0.1",
• "externalHost": "",
• "externalHttpPort": 0,
• "externalHttpsPort": 0,
• "checkForwardedHeaders": false,
• "sslCertificateId": "6789abcd-ef01-2345-6789-abcdef012345",
• "auth": "basic"

}

Retrieves multiple SharedServerInformation objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (SharedServerInformation) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/SharedServerInformation/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "apiType": "basic",
      • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
      • "auth": "none",
      • "authToken": "bcdef012-3456-789a-bcde-f0123456789a",
      • "checkForwardedHeaders": "false",
      • "externalHost": "",
      • "externalHttpPort": "0",
      • "externalHttpsPort": "0",
      • "httpPort": "9090",
      • "httpsPort": "9093",
      • "internalHost": "127.0.0.1",
      • "maxThreads": "250",
      • "minAuth": "basic",
      • "overrideUrl": "false",
      • "sslCertificateId": "6789abcd-ef01-2345-6789-abcdef012345",
      • "url": "http://system.sub.domain.tld:9090"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}