Skip to main content

Reachability flow via Hosted Agent

tip

If your target API is internal or not reachable from the public internet, you'll likely need a Hosted Agent to scan it. See Do I Need a Hosted Agent? to decide, then follow the Hosted Agent quickstart to deploy one.

Create Application​

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

  • Click Add Application.

    Add Application button

  • Select OpenAPI Spec.

    OpenAPI Spec option in the Add Application window

  • Enter the Name for the application, click Browse Files, and upload the document.

    Application name field and Browse Files upload option

  • Click the Continue button to create the application.

    Continue button in the Add Application window

  • Click Onboard.

    Onboard button

  • The application creation process displays.

    Application creation progress

  • Once the application is created, check the reachability status of the instance URL. The status displays as "Unreachable" because the API is behind the firewall.

    Reachability status showing Unreachable

  • To establish reachability, click Test Reachability under Setup Application Reachability in App Model.

    Test Reachability option under Setup Application Reachability in App Model

  • The Test reachability process runs.

    Test reachability in progress

  • The Test Reachability result displays.

  • The result shows that the given instance URL is not reachable, with an option to create a private hosted agent.

  • Click private hosted agent.

    Test Reachability result with the private hosted agent link

  • You are redirected to the Hosted Agent window.

    Hosted Agent window

  • Click the New Hosted Agent button to create a hosted agent.

    New Hosted Agent button in the Hosted Agent window

  • The Setup Hosted Agents window opens.

    Setup Hosted Agents window

  • Enter the hosted agent name and click the Create Hosted Agent button.

    Hosted agent name field and Create Hosted Agent button

  • Select the desired environment type and click Download Installation Instructions to download the instructions required to configure the hosted agent.

    Environment type selection and Download Installation Instructions button

  • The final step of Setup Hosted Agents displays the Finish button. Click Finish.

    Finish button on the final Setup Hosted Agents step

  • In the Hosted Agent window, the newly created hosted agent displays with the status "PROVISIONED".

    Hosted agent listed with PROVISIONED status

  • After you install the hosted agent in your environment, the status changes to "ACTIVE".

    Hosted agent listed with ACTIVE status

  • Revisit the application and check the reachability status. It now displays as "Reachable".

    Reachability status showing Reachable