Skip to main content

Reload Spec

Reloading the API specification allows you to refresh and update the existing specification in your application.

you can update the specification using three approaches: File Upload, URL, or API Gateway.

Reload Spec with File​

Activity logs

  • Select the Endpoints tab

Activity logs

  • Now click on the Reload Spec

Activity logs

  • You will see the Reload Spec form with different options.

Activity logs

  • The Browse Files option allows you to upload your API specification directly from your local system.

  • Reload Spec Scope

    • Remove Missing Endpoints - Automatically clean up your application by deleting any endpoints that no longer exist in the updated specification, ensuring your application stays accurate and up to date. Disable the toggle button if you want to keep the existing endpoints.
    • Retain Existing Endpoint Configurations - Preserve custom endpoint settings such as authorization, parameters, headers, data types, and example values. When disabled, the system will override these settings and apply updates from the new specification.
    • Retain Existing Parameter Values - By default, manually entered parameter values at the instance or endpoint level are preserved when reloading the specification. You can disable this option to overwrite them with values from the updated specification.

    Select the required options and click on the Reload button.

Activity logs

  • Reload task submitted successfully. We can track the progress in Activity logs.

Activity logs

note

Users with View permissions cannot reload the specification in a shared application.

Reload Spec with Url​

Activity logs

  • Select the Endpoints tab

Activity logs

  • Now click on the Reload Spec

Activity logs

  • You will see the Reload Spec form with different options.

Activity logs

  • Click on the Url tab

Activity logs

  • Now you will see a form with different options.

Activity logs

  • Enter the URL from which the application will fetch the API specification.

  • Reload Spec Scope

    • Remove Missing Endpoints - Automatically clean up your application by deleting any endpoints that no longer exist in the updated specification, ensuring your application stays accurate and up to date. Disable the toggle button if you want to keep the existing endpoints.
    • Retain Existing Endpoint Configurations - Preserve custom endpoint settings such as authorization, parameters, headers, data types, and example values. When disabled, the system will override these settings and apply updates from the new specification.
    • Retain Existing Parameter Values - By default, manually entered parameter values at the instance or endpoint level are preserved when reloading the specification. You can disable this option to overwrite them with values from the updated specification.

    Select the required options and click on the Reload button.

    Activity logs

    • Reload task submitted successfully. We can track the progress in Activity logs.

Activity logs

note

Users with View permissions cannot reload the specification using a URL in a shared application.

Reload Spec with API Gateway​

Activity logs

  • Select the Endpoints tab

Activity logs

  • Now click on the Reload Spec

Activity logs

  • If you created the application with Gateway, then You will see the API Gateway (currently we support AWS API, SwaggerHub, GraphQl, Azure APIM and MuleSoft gateways) tab selected with linked connection.

Activity logs

  • Here, if you want you can change the existing connection and use new connection and change the Spec.

    • Steps to unlink the connection and reload with new spec from Gateway

      • Click on the Remove spec to unlink the connection.

      Activity logs

      • Click on the "Confirm"

      Activity logs

      • Now you will see the available APIs from the gateway.

      Activity logs

      • If you want to change the connection or want to create a new connection then click on the "Back" button

      Activity logs

      • Click the Select button next to the desired gateway connection to use an existing connection, or click New Connection to create a new one.

      Activity logs

      • Now click on the "Select" to use the existing connection.

      Activity logs

      • You will see a list of the available APIs from the gateway and select the required API from the list.

      Activity logs

  • Now Specify the Reload Spec Scope

    • Remove Missing Endpoints - Automatically clean up your application by deleting any endpoints that no longer exist in the updated specification, ensuring your application stays accurate and up to date. Disable the toggle button if you want to keep the existing endpoints.
    • Retain Existing Endpoint Configurations - Preserve custom endpoint settings such as authorization, parameters, headers, data types, and example values. When disabled, the system will override these settings and apply updates from the new specification.
    • Retain Existing Parameter Values - By default, manually entered parameter values at the instance or endpoint level are preserved when reloading the specification. You can disable this option to overwrite them with values from the updated specification.

  • otherwise, Click the "Reload Now" button to fetch the latest specification immediately.

Activity logs

  • Reload task submitted successfully. We can track the progress in Activity logs.

Activity logs

note

Users with View permissions cannot reload the specification using API Gateway in a shared application.

Auto-Reload Spec with API Gateway​

Auto-Reload Spec via API Gateway feature enables users to automatically fetch and update API specifications directly from their connected API Gateway (currently we support AWS API, Azure APIM, Postman and MuleSoft gateways), ensuring that the most up-to-date API definitions are used for testing.

Instead of manually uploading a file or specifying a URL, users can now select an existing gateway connection and choose the specific API to be reloaded. This reduces manual effort, minimizes errors, and ensures API specifications stay aligned with production and staging deployments.

  • You can Shedule the reload spec by enabling "Enable auto re-load" for linked connections.

    • Enable auto re-load - When enabled, the application will automatically check for unregistered APIs and onboard them in batches of 50, based on the frequency(currently we support weekly). Any remaining unregistered APIs will be included in the next batch.

    Activity logs

    • After selecting the fields, Click on the "Save Schedule" button.

    Activity logs

    • Schedule saved. The specification will auto-reload according to the selected schedule.
    note

    Users with View permissions cannot schedule the reload specification in a shared application for linked connections.