Waiting for engine...
Skip to main content

Deploy component operation (Legacy deployment, Deprecated)

You can use the deployComponent operation to copy a component deployment from one environment to another.

note

The Deploy component operation is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Deployed Package object instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about 's API object deprecation status, refer to the API deprecation and versioning policy topic.

Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new Deployment workflow and Enabling Packaged Component Deployment for Legacy accounts. In the meantime, do not use the replacement API without first converting your Legacy account.

You can use this operation to copy any type of deployable component, including the following components:

  • API Service
  • Proxy
  • Certificate (public X.509 certificates)
  • Custom Library
  • Flow Service
  • Process
  • Processing Group
  • Process Route

Parameters​

You can use the following parameters to perform the deployComponent operation:

  • deploymentId - The ID of the component deployment to copy.

    The ID found in the Process Deployment History table on the Deploy page.

  • environmentId - The ID of the deployment environment to copy the component deployment to.

    This ID can be found in the Environment Properties section of the Runtime Management page.

  • digest - The digest corresponds to a hash of the configurations for the components that are included in the deployment.

    This digest must match the deployment's digest in order for the deployment to be copied. A match ensures that the deployment you are intending to copy is actually copied. The digest can be retrieved by using the API's GET call for Deployment objects.

  • listenerStatus - (Optional, for listener processes only) Used to copy a listener process deployment in a specific state, either RUNNING or PAUSED.

    By default, listener processes that do not yet exist in the target environment are deployed in a running state. If the listener process exists in the target environment, it is deployed in the same state as the existing process unless you include this parameter.

SOAP implementation​

To perform a deployComponent operation, use the it from the WSDL. The following example shows a SOAP envelope (without WS-Security headers) for performing this 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:deployComponent>
         <api:deploymentId>89abcdef-0123-4567-89ab-cdef01234567</api:deploymentId>
         <api:environmentId>456789ab-cdef-0123-4567-89abcdef0123</api:environmentId>
         <api:digest>abb98d1a5b659afbe77cc361cb255c8b</api:digest>
      </api:deployComponent>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:deployComponentResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:successful>true</bns:successful>
      </bns:deployComponentResponse>
   </S:Body>
</S:Envelope>
On this Page