Skip to main content
Feedback

Importing API from Boomi Platform

This feature lets you discover and import the Boomi Platform API Service in the Cloud API Management dashboard. You can import a new API Service from Platform to Cloud API Management or reimport an existing Platform API Service in Cloud API Management.

When you first import a Platform API Service, a new API definition is created in the Cloud API Management dashboard. If the API Service already exists in the Cloud API Management dashboard and you import it again, the existing Cloud API Management API definition is updated.

note

  • The Import API from Boomi Platform option on the Manage your APIs with API Definitions page is only available to Platform-enabled accounts (or Platform users), when the feature flag is enabled for your area in Cloud API Management.

    If this option is not visible, the feature is likely disabled for your area, or you are not a Platform user. To enable it, contact the Boomi Account Representative. Note that once enabled, it cannot be disabled.

  • In addition to the Cloud API Management Administrator role, you also require these Platform privileges: API Management and Environment Management to import an API Service from the Platform to Cloud API Management. Refer to User roles and privileges for more information.

Procedure

tip

To ensure a successful import, review Before You Import for prerequisites, considerations, and import behaviors.

  1. Navigate to New API Definition > Import from Boomi Platform. The Import from Boomi Platform wizard opens, displaying all the API Services deployed on the Platform.

    important

    When importing an API Service from Platform to Cloud API Management, the Boomi session expires after 4–5 minutes of inactivity. If the session expires, close the Import from Boomi Platform wizard and relaunch Cloud API Management via Boomi Platform.

  2. Import a new API or an existing API.

    1. If importing a new API, follow the steps below:

      1. On the wizard's first screen, select an API that has no existing version assigned by clicking the radio button next to the row, or by selecting the entire row.

        The columns on the wizard are resizable. You can drag and drop the columns or resize them if you cannot view the text of a specific column. You can also sort the columns in ascending or descending order.

        Image

        note

        1. You can import only one API at a time. Only REST APIs can be imported from the Platform. GraphQL, SOAP, JSON-RPC, XML-RPC, and other endpoint types are not supported.

        2. You cannot import an API if its Existing Version and Latest Version are the same. Identical versions indicate that the Platform API Service was already imported into Cloud API Management. To proceed, select an API whose existing and latest versions differ. However, reimporting is possible for the same API if a newer version is available.

      2. Optional: In the Search box, enter the text. The search performs a partial or full match across all available columns.

      3. Optional: Click the Filters icon. This opens the Filter pop-up window.

        1. In Environment, select a Platform environment from the list to filter APIs for that environment.

        2. In Gateway Authentication, select the type of gateway authentication.

        3. Click Apply to set the filter values, or click Reset to reset them.

      4. Click Next to go to the next screen.

      5. On the wizard's second screen, select an Organization and Public Endpoint Domain from the list.

        1. In the Select Endpoints section:

          1. Next to the Endpoint Name column, select either the checkbox or the entire row to choose an endpoint. By default, the individual method checkboxes are selected.

            If the OAS is not configured for the imported API, the endpoint list appears empty during import. Refer to the OpenAPI Specification (OAS) requirement in Before You Import for more information.

          2. Select or deselect individual method checkboxes (GET, POST, PUT, PATCH, or DELETE) for the chosen endpoint.

      6. Click Import as New API.

    2. If importing an existing API, follow the steps below:

      1. On the wizard's first screen, select an API whose Existing Version and Latest Versions are different by clicking the radio button next to the row, or by selecting the entire row.

        note

        You can reimport an API that has already been imported if its Existing Version and Latest Version are different. When reimporting an already-imported API, it upgrades to the latest version and resets the configuration. Ensure you review API endpoints before reimporting.

        Image

        1. Click Next to go to the next screen.

        2. On the wizard's second screen, in the Select Endpoints section:

          1. Next to the Endpoint Name column, select either the checkbox or the entire row to choose an endpoint. Here, only the previously selected allowed methods are selected by default, but you can also select additional methods.

          2. Select or deselect individual method checkboxes (GET, POST, PUT, PATCH, or DELETE) for the chosen endpoint.

            note

            By default, the Organization and Public Endpoint Domain field remains disabled during the reimport of a previously imported API.

        3. Click Import and upgrade existing API.

Next Steps (Optional)

On successful API creation, the new API appears on the Manage your APIs with API Definitions page. To view the endpoint configuration details of your imported API:

  1. On the Manage your APIs with API Definitions page, click the API link. This opens the Endpoints: <your imported api name> page. Click the endpoint link to open the Methods: <your imported api name> page.

  2. On the left side, navigate to the available tabs (Domains and Traffic Routing, Key & Method Detection, and so on) to view the configuration details for each section.

On this Page