Boomi Platform API Reference (1.0.0) - SharedWebServer

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

SharedWebServer

The Shared Web Server object details the configuration settings for a Runtime's Shared Web Server. It includes various fields to specify security, performance, and connectivity attributes. The configuration can be managed using GET and UPDATE operations, and the data can be represented in XML or JSON formats.

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 SharedWebServer object

Retrieves the details of a Shared Web Server configuration for this atom/cloud ID by its unique ID. The response can be in either XML or JSON format based on your request.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId required	string
required	object (SharedWebServerCloudTennantGeneral)
required	object (SharedWebServerCors)
required	object (SharedWebServerGeneral)
required	object (SharedWebServerUserManagement)
shouldRestartPlugin	boolean

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}/SharedWebServer/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SharedWebServer",
• "atomId": "ea19beb4-3f9f-407e-b019-ac508c0aa73b",
• "generalSettings": {

  • "@type": "SharedWebServerGeneral",
  • "apiType": "ADVANCED",
  • "authentication": {

    • "@type": "SharedWebServerAuthentication",
    • "authType": "CUSTOM",
    • "loginModuleClassName": "as",
    • "cacheAuthorizationCredentials": false,
    • "loginModuleOptions": {

      • "@type": "SharedWebServerLoginModuleConfiguration"

      },
    • "cacheAuthenticationTimeout": 0

    },
  • "overrideUrl": false,
  • "baseUrl": "http://dd:9090",
  • "examineForwardHeaders": false,
  • "externalHost": "dd",
  • "internalHost": "",
  • "listenerPorts": {

    • "@type": "ListenerPortConfiguration",
    • "port": [

      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 9090,
        • "ssl": false,
        • "authType": "CUSTOM",
        • "externalPort": 0,
        • "externalSSL": false,
        • "defaultPort": true,
        • "baseUrlForRequest": "http://dd:9090"

        },
      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 9091,
        • "ssl": false,
        • "authType": "BASIC",
        • "externalPort": 10,
        • "externalSSL": false,
        • "defaultPort": false,
        • "baseUrlForRequest": "http://dd:10"

        }

      ]

    },
  • "maxNumberOfThreads": 250,
  • "protectedHeaders": {

    • "@type": "SharedWebServerProtectedHeaders"

    },
  • "sslCertificate": ""

  },
• "userManagement": {

  • "@type": "SharedWebServerUserManagement",
  • "enableAPIMInternalRoles": false,
  • "users": [

    • {

      • "@type": "SharedWebServerUser",
      • "roleAssociations": [ ],
      • "username": "boomi-internal",
      • "usingIPFilters": false,
      • "usingComponentFilters": false

      }

    ]

  },
• "corsConfiguration": {

  • "@type": "SharedWebServerCors",
  • "origins": [

    • {

      • "@type": "SharedWebServerCORSOrigin",
      • "allowRequestHeaders": [ ],
      • "allowResponseHeaders": [ ],
      • "allowMethods": [ ],
      • "EnableHTTPRequestHandling": false,
      • "EnableHTTPSRequestHandling": false,
      • "allowCredentials": false,
      • "domain": "domain",
      • "cacheTimeout": 53

      }

    ]

  }

}

Modifies or updates a SharedWebServer object

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

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId required	string
required	object (SharedWebServerCloudTennantGeneral)
required	object (SharedWebServerCors)
required	object (SharedWebServerGeneral)
required	object (SharedWebServerUserManagement)
shouldRestartPlugin	boolean

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId required	string
required	object (SharedWebServerCloudTennantGeneral)
required	object (SharedWebServerCors)
required	object (SharedWebServerGeneral)
required	object (SharedWebServerUserManagement)
shouldRestartPlugin	boolean

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}/SharedWebServer/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SharedWebServer",
• "atomId": "8f4c9283-695e-4c9b-963e-b66805832f68",
• "generalSettings": {

  • "@type": "SharedWebServerGeneral",
  • "apiType": "INTERMEDIATE",
  • "authentication": {

    • "@type": "SharedWebServerAuthentication",
    • "authType": "BASIC",
    • "cacheAuthorizationCredentials": false

    },
  • "overrideUrl": false,
  • "baseUrl": "http://cloudAtmSWS:9090",
  • "examineForwardHeaders": false,
  • "externalHost": "",
  • "internalHost": "",
  • "listenerPorts": {

    • "@type": "ListenerPortConfiguration",
    • "port": [

      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 8080,
        • "ssl": true,
        • "authType": "CLIENT_CERT",
        • "externalPort": 0,
        • "externalSSL": false,
        • "defaultPort": false

        },
      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 9090,
        • "ssl": false,
        • "authType": "BASIC",
        • "externalPort": 0,
        • "externalSSL": false,
        • "defaultPort": false

        }

      ]

    },
  • "maxNumberOfThreads": 250,
  • "protectedHeaders": {

    • "@type": "SharedWebServerProtectedHeaders"

    },
  • "sslCertificate": ""

  },
• "userManagement": {

  • "@type": "SharedWebServerUserManagement",
  • "enableAPIMInternalRoles": false,
  • "users": [

    • {

      • "@type": "SharedWebServerUser",
      • "roleAssociations": [ ],
      • "username": "boomi-internal",
      • "usingIPFilters": false,
      • "usingComponentFilters": false

      }

    ]

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SharedWebServer",
• "atomId": "8f4c9283-695e-4c9b-963e-b66805832f68",
• "generalSettings": {

  • "@type": "SharedWebServerGeneral",
  • "apiType": "INTERMEDIATE",
  • "authentication": {

    • "@type": "SharedWebServerAuthentication",
    • "authType": "BASIC",
    • "cacheAuthorizationCredentials": false

    },
  • "overrideUrl": false,
  • "baseUrl": "http://cloudAtmSWS:9090",
  • "examineForwardHeaders": false,
  • "externalHost": "",
  • "internalHost": "",
  • "listenerPorts": {

    • "@type": "ListenerPortConfiguration",
    • "port": [

      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 8080,
        • "ssl": true,
        • "authType": "CLIENT_CERT",
        • "externalPort": 0,
        • "externalSSL": false,
        • "defaultPort": false

        },
      • {

        • "@type": "SharedWebServerPort",
        • "enablePort": true,
        • "port": 9090,
        • "ssl": false,
        • "authType": "BASIC",
        • "externalPort": 0,
        • "externalSSL": false,
        • "defaultPort": false

        }

      ]

    },
  • "maxNumberOfThreads": 250,
  • "protectedHeaders": {

    • "@type": "SharedWebServerProtectedHeaders"

    },
  • "sslCertificate": ""

  },
• "userManagement": {

  • "@type": "SharedWebServerUserManagement",
  • "enableAPIMInternalRoles": false,
  • "users": [

    • {

      • "@type": "SharedWebServerUser",
      • "roleAssociations": [ ],
      • "username": "boomi-internal",
      • "usingIPFilters": false,
      • "usingComponentFilters": false

      }

    ]

  }

}

Retrieves multiple SharedWebServer 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 (SharedWebServer) 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}/SharedWebServer/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": {

      • "atomId": "string",
      • "cloudTennantGeneral": {

        • "apiType": "string",
        • "authType": "string",
        • "baseUrl": "string",
        • "listenerPorts": {

          • "port": [

            • {

              • "authType": "string",
              • "baseUrlForRequest": "string",
              • "defaultPort": true,
              • "enablePort": true,
              • "externalPort": 0,
              • "externalSSL": true,
              • "port": 0,
              • "ssl": true

              }

            ]

          }

        },
      • "corsConfiguration": {

        • "origins": [

          • {

            • "EnableHTTPRequestHandling": false,
            • "EnableHTTPSRequestHandling": false,
            • "allowCredentials": false,
            • "allowMethods": [

              • "string"

              ],
            • "allowRequestHeaders": [

              • "string"

              ],
            • "allowResponseHeaders": [

              • "string"

              ],
            • "cacheTimeout": 0,
            • "domain": "string",
            • "ports": [

              • 0

              ]

            }

          ]

        },
      • "generalSettings": {

        • "apiType": "string",
        • "authentication": {

          • "authType": "string",
          • "cacheAuthenticationTimeout": 0,
          • "cacheAuthorizationCredentials": true,
          • "clientCertificateHeaderName": "string",
          • "loginModuleClassName": "string",
          • "loginModuleOptions": {

            • "loginModule": [

              • {

                • "encrypt": true,
                • "name": "string",
                • "value": "string"

                }

              ]

            }

          },
        • "baseUrl": "string",
        • "examineForwardHeaders": true,
        • "externalHost": "string",
        • "internalHost": "string",
        • "listenerPorts": {

          • "port": [

            • {

              • "authType": "string",
              • "baseUrlForRequest": "string",
              • "defaultPort": true,
              • "enablePort": true,
              • "externalPort": 0,
              • "externalSSL": true,
              • "port": 0,
              • "ssl": true

              }

            ]

          },
        • "maxNumberOfThreads": 0,
        • "overrideUrl": true,
        • "protectedHeaders": {

          • "header": [

            • "string"

            ]

          },
        • "sslCertificate": "string"

        },
      • "shouldRestartPlugin": true,
      • "userManagement": {

        • "enableAPIMInternalRoles": true,
        • "users": [

          • {

            • "clientCertificate": "string",
            • "componentFilters": [

              • "string"

              ],
            • "externalUsername": "string",
            • "ipFilters": [

              • "string"

              ],
            • "roleAssociations": [

              • "string"

              ],
            • "token": "string",
            • "username": "string",
            • "usingComponentFilters": true,
            • "usingIPFilters": true

            }

          ]

        }

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

    }

  ]

}