Updating an API by Importing an API from a File

Edit online

Before you begin

You must have the API Gateway's manage APIs or Activate/deactivate APIs functional privilege assigned to perform this task. You can not update an API by importing an API from a file if the API is in the active state.

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 file.
  5. Provide the following information:
    Field Description
    Select file Click Browse to browse to the location of file to be imported and select the required file or ZIP format file.

    The REST API can be updated using only the Swagger or RAML file type. The SOAP API can be updated using only the WSDL file type.

    Root File Name If you have selected a file in ZIP format, type the relative path of the main file within the ZIP file.
    Name Name for the API. Edit or delete the name of the existing API displayed.
    • If you provide an API name, this overwrites the API name mentioned in the uploaded file and the API is updated with the name provided.
    • If you do not provide an API name, the API name mentioned in the uploaded file is picked up and the API is updated with that name.
    Type Select the required type. The available types are OpenAPI, RAML, Swagger, WSDL, 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 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 imported file 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 imported file is used.
  6. Click Update.
    The API definition is updated with the latest changes from the file and is displayed in the API details page.