Updating an API by Importing an API from a URL

Edit online

Before you begin

You must have the webMethods API Gateway's manage APIs or activate/deactivate APIs functional privilege assigned to perform this task.

About this task

To modify API details

Procedure

  1. Click APIs in the title navigation bar.
  2. Select the required API from the list of APIs.
    The API details page for the selected API appears.
  3. Click and select Update.
    The Update API window appears.
  4. Select Update API by importing from URL.
  5. Provide the following information:
    Field Description
    URL Type the URL from which the API is being imported.
    Note: The REST API can be updated using only the Swagger or RAML type information that the URL is pointing to. The SOAP API can be updated using only the WSDL file type information that the URL is pointing to. The entity sets, singletons, function imports, and action imports of an OData API can only be updated by a re-import of the OData API definition through the URL.
    Protected Select this option if you want to import an API from a URL that is password protected. The user name and password fields are displayed using which you can access the provided URL.
    Username Type the user name required to access the password protected URL.

    If you have selected the Protected option, this field is displayed.

    Password Type the password associated with the username.

    If you have selected the Protected option, this field is displayed.

    Name Name for the API. The existing name of the API is automatically displayed.
    • If you provide an API name, this overwrites the API name mentioned in the file referred by URL and the API is updated with the name provided.
    • If you do not provide an API name, the API name mentioned in the file referred to by URL is picked up and the API is updated with that name.
    Type Select the required type. The available types are OpenAPI, RAML, Swagger, WSDL, OData, and GraphQL SDL.

    For a REST API, the available options are RAML and Swagger.

    For a SOAP API, the available option is WSDL.

    For a OData API, the available option is OData.

    For a GraphQL API, the available option is GraphQL SDL.

    Version Version number of the API. The existing version number of the API is automatically displayed. You can edit or delete the version number. If the version number is deleted and the file referred to by URL does not have a version number, then the system automatically assigns a version number during the update.

    This overwrites the version of the API.

    Description Description of the API. The existing description of the API is automatically displayed. You can edit or delete the description. If you delete the description then the description from the file referred to by URL is used.
  6. Click Update.
    The API definition is updated with the latest changes from the URL and is displayed in the API details page.