Skip to main content

Onboard an API with SwaggerHub


Prerequisites​

  • The APIsec platform needs an API Key to connect with SwaggerHub Cloud

    • Follow the steps below to obtain the API Key

      • Click on Profile Icon

        Profile icon in SwaggerHub

      • Select API Key and Copy API Key

        API Key option

  • The APIsec platform needs an API Key and Server URL to connect with SwaggerHub On-premises

    • Follow the above steps to get the API Key.
    • Set up the server address, complete the on-premise installation, and then use it as the SwaggerHub Server URL.

Start adding a new application​

Select SwaggerHub Gateway​

  • Choose the SwaggerHub Gateway option.

    Choose the SwaggerHub Gateway

  • If existing connections are available, they will be displayed in the Connections list. To create a new connection, click New Connection.

  • If no connections exist, a connection form is displayed, allowing you to enter the required details and create a connection.

    New Connection option

Enter application details​

You can onboard using two deployment types:

  1. Cloud
  2. On-premises
  • Enter the following details for Cloud

    • Name, Deployment Type, and API Key.

      SwaggerHub Cloud connection form

  • Enter the following details for On-premises

    • Name, API Key, Server URL, Source and Destination

      SwaggerHub On-premises connection form

  • Click Test Connection

    Test Connection button

  • Test Connection Success

    Connection test success message

  • Click Create Connection

    Create Connection button

  • Select Organization and Project and select API

    Select Organization, Project, and API

  • Click Continue

    Continue button

  • Click Onboard

    Onboard button

  • SwaggerHub application dashboard

    SwaggerHub application dashboard

Auto-Onboard​

The Auto-Onboard feature streamlines API onboarding by automatically detecting and registering unregistered APIs from SwaggerHub Gateway. This ensures that all APIs, including newly published ones, are consistently onboarded and tested for vulnerabilities with minimal manual effort.

Enable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the SwaggerHub

    Onboard Applications for SwaggerHub

  • Enable Auto-Onboard of any existing SwaggerHub connection.

    Auto-Onboard toggle

  • Fill in the SwaggerHub AutoOnboard Details and click Save Schedule

    • Frequency – How often the onboarding should occur. By default it is weekly.
    • Day of the Week – Select the specific day for onboarding.
    • Hour – The exact time (in hours and minutes) when the onboarding should start.
    • Timezone – The timezone in which the schedule should be applied
    • Organization - Select Organization. If the selected organization has no projects then all APIs from that organization will be automatically selected for auto-onboarding
    • API Selection Scope - Select whether to auto-onboard all available APIs or limit onboarding to only those published after the specified date.

    SwaggerHub AutoOnboard details and Save Schedule button

    • Successfully saved auto-onboard details

    Auto-onboard saved confirmation

Update Schedule​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the SwaggerHub

    Onboard Applications for SwaggerHub

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • Update the details and click Update Schedule

    Update Schedule button

Disable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the SwaggerHub

    Onboard Applications for SwaggerHub

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • In Edit SwaggerHub AutoOnboard Details, disable the Enable Automatic API Onboarding.

    Disable automatic API onboarding

  • Click Yes to confirm

    Confirmation dialog

  • Auto-Onboard details deleted.

    Auto-Onboard details deleted message

Edit SwaggerHub connection​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the SwaggerHub

    Onboard Applications for SwaggerHub

  • A list of existing SwaggerHub connections is displayed.

    SwaggerHub connections list

  • Select the Pencil icon next to the connection you want to edit.

    Pencil icon next to a connection

  • Update the required details and click Test Connection

    Test Connection button

  • Once the connection test succeeds, click Update Connection

    Update Connection button

  • The updated connection is now displayed in the connections list.

    Updated connections list

Delete SwaggerHub connection​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the SwaggerHub

    Onboard Applications for SwaggerHub

  • A list of existing SwaggerHub connections is displayed.

    SwaggerHub connections list

  • Select the Delete icon next to the connection you want to delete.

    Delete icon next to a connection

  • Click Delete to confirm

    Delete confirmation dialog

  • The deleted connection is no longer displayed in the connections list.

    Connections list after deletion