Skip to main content
Version: 3.8

API Packs

API Packs are the way APIs are exposed to developers. An API Pack is a package of resources/operations created from several APIs that include allowable methods.

apipacks

info

The REST, SOAP and GraphQL API Packs are separated and shown in their own tabs, while all API Packs are listed under the All tab.

Search an API Pack​

The Search tool on the API Pack list pages allows the user to search for an API Pack.

searchapipack

  1. Click the Search icon.

The pop up appears as shown below.

searchapipack1

  1. Enter the Key word.
tip

Search results shows matches from the following API Pack components:

  • API Pack name
  • Overview (all components)
  • Resource names in the pack
  • Description of each resource in the pack
  • Usage Plan name
  • Usage Plan - Associated Policy name
  • API Name
  • API Version number
  • Monetization strategy used
  • Plan documentation file name
  • Pack documentation file name
  • Pack branding details
  1. Click Search.

The Search results appears as shown below.

searchapipack2

Sort API Pack Name​

The sort capability allows you to arrange API Pack Names in a certain order based on predefined criteria.

  1. Click on the API Pack Name to apply sort ascending.

sortascendingapipack

On applying sort ascending, the upward arrow will be highlighted.

  1. Click on the API Pack Name again to sort descending.

sortdescendingapipack

On applying sort descending, the downward arrow will be highlighted.

  1. Click on the API Name again to cancel sorting.

cancelsortingapipack

Cancelling sort disables both the upward and downward arrows.

cancelsortingapipack1

Filter by API Pack State​

The Filters allow users to restrict or limit the displayed data based on API Pack State, which helps in focusing on the relevant data.

  1. Click the Filter icon available next to the API Pack State.

filterapipack

The drop down appears as shown below.

filterapipack1

  1. Enable the checkboxes next to the filter options to select them.

  2. Click OK.

On proceeding, the results are displayed with the highlighted filter icon, shown below.

filterapipack2

  1. Click the Filter icon, then the Reset button and finally click OK to reset the filter.

filterapipack3

Export all approved and published API Packs​

The Export function allows users to download all approved and published API Packs for purposes such as backup, migration, etc.

exportallapipacks

  1. Click the Cogwheel icon.

The drop down appears as shown below.

exportallapipacks1

  1. Click Export to download all the all approved and published API Packs in zip format.

Import all approved and published APIs​

The Import functionality enables users to upload API Packs, making it easier to migrate API Packs between environments, restore backups, etc.

exportallapipacks

  1. Click the Cogwheel icon.

The drop down appears as shown below.

importallapipacks

  1. Click Import.

The Import API Pack Details dialog box appears as shown below.

info

There are two methods for importing Approved and Published API Packs:

  • Full Import - The existing artifacts will be removed from this deployment and the artifacts in the imported file shall be populated. SSL certificates, if any, must be manually configured.

  • Delta Import - If the artifact being imported already exists in this instance, it will be updated with the information from the imported file. Artifacts present in this instance but not in the imported file will be left untouched. If the artifact being imported does not exist in this instance, it will be created. SSL certificates, if any, must be configured manually.

  1. Select the Import method as either Full Import or Delta Import as per the requirement.

  2. Click to Upload the backup file from your local disk.

  1. Click Import to import the file.